Permalink
Please sign in to comment.
Showing
with
254 additions
and 0 deletions.
- +10 −0 .gitignore
- +5 −0 .travis.yml
- +74 −0 CODE_OF_CONDUCT.md
- +6 −0 Gemfile
- +21 −0 LICENSE.txt
- +43 −0 README.md
- +10 −0 Rakefile
- +14 −0 bin/console
- +8 −0 bin/setup
- +36 −0 borg-reducer.gemspec
- +7 −0 lib/borg/reducer.rb
- +5 −0 lib/borg/reducer/version.rb
- +11 −0 test/borg/reducer_test.rb
- +4 −0 test/test_helper.rb
@@ -0,0 +1,10 @@ | ||
/.bundle/ | ||
/.yardoc | ||
/_yardoc/ | ||
/coverage/ | ||
/doc/ | ||
/pkg/ | ||
/spec/reports/ | ||
/tmp/ | ||
*.swp | ||
.DS_Store |
@@ -0,0 +1,5 @@ | ||
sudo: false | ||
language: ruby | ||
rvm: | ||
- 2.4.1 | ||
before_install: gem install bundler -v 1.16.1 |
@@ -0,0 +1,74 @@ | ||
# Contributor Covenant Code of Conduct | ||
## Our Pledge | ||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to making participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, gender identity and expression, level of experience, | ||
nationality, personal appearance, race, religion, or sexual identity and | ||
orientation. | ||
## Our Standards | ||
Examples of behavior that contributes to creating a positive environment | ||
include: | ||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
Examples of unacceptable behavior by participants include: | ||
* The use of sexualized language or imagery and unwelcome sexual attention or | ||
advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
## Our Responsibilities | ||
Project maintainers are responsible for clarifying the standards of acceptable | ||
behavior and are expected to take appropriate and fair corrective action in | ||
response to any instances of unacceptable behavior. | ||
Project maintainers have the right and responsibility to remove, edit, or | ||
reject comments, commits, code, wiki edits, issues, and other contributions | ||
that are not aligned to this Code of Conduct, or to ban temporarily or | ||
permanently any contributor for other behaviors that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
## Scope | ||
This Code of Conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. Examples of | ||
representing a project or community include using an official project e-mail | ||
address, posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. Representation of a project may be | ||
further defined and clarified by project maintainers. | ||
## Enforcement | ||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting the project team at ryan.deschamps@gmail.com. All | ||
complaints will be reviewed and investigated and will result in a response that | ||
is deemed necessary and appropriate to the circumstances. The project team is | ||
obligated to maintain confidentiality with regard to the reporter of an incident. | ||
Further details of specific enforcement policies may be posted separately. | ||
Project maintainers who do not follow or enforce the Code of Conduct in good | ||
faith may face temporary or permanent repercussions as determined by other | ||
members of the project's leadership. | ||
## Attribution | ||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, | ||
available at [http://contributor-covenant.org/version/1/4][version] | ||
[homepage]: http://contributor-covenant.org | ||
[version]: http://contributor-covenant.org/version/1/4/ |
@@ -0,0 +1,6 @@ | ||
source "https://rubygems.org" | ||
git_source(:github) {|repo_name| "https://github.com/#{repo_name}" } | ||
# Specify your gem's dependencies in borg-reducer.gemspec | ||
gemspec |
@@ -0,0 +1,21 @@ | ||
The MIT License (MIT) | ||
Copyright (c) 2018 Ryan Deschamps | ||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
The above copyright notice and this permission notice shall be included in | ||
all copies or substantial portions of the Software. | ||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
THE SOFTWARE. |
@@ -0,0 +1,43 @@ | ||
# Borg::Reducer | ||
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/borg/reducer`. To experiment with that code, run `bin/console` for an interactive prompt. | ||
TODO: Delete this and the text above, and describe your gem | ||
## Installation | ||
Add this line to your application's Gemfile: | ||
```ruby | ||
gem 'borg-reducer' | ||
``` | ||
And then execute: | ||
$ bundle | ||
Or install it yourself as: | ||
$ gem install borg-reducer | ||
## Usage | ||
TODO: Write usage instructions here | ||
## Development | ||
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. | ||
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). | ||
## Contributing | ||
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/borg-reducer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. | ||
## License | ||
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). | ||
## Code of Conduct | ||
Everyone interacting in the Borg::Reducer project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/borg-reducer/blob/master/CODE_OF_CONDUCT.md). |
@@ -0,0 +1,10 @@ | ||
require "bundler/gem_tasks" | ||
require "rake/testtask" | ||
Rake::TestTask.new(:test) do |t| | ||
t.libs << "test" | ||
t.libs << "lib" | ||
t.test_files = FileList["test/**/*_test.rb"] | ||
end | ||
task :default => :test |
@@ -0,0 +1,14 @@ | ||
#!/usr/bin/env ruby | ||
require "bundler/setup" | ||
require "borg/reducer" | ||
# You can add fixtures and/or initialization code here to make experimenting | ||
# with your gem easier. You can also use a different console, if you like. | ||
# (If you use this, don't forget to add pry to your Gemfile!) | ||
# require "pry" | ||
# Pry.start | ||
require "irb" | ||
IRB.start(__FILE__) |
@@ -0,0 +1,8 @@ | ||
#!/usr/bin/env bash | ||
set -euo pipefail | ||
IFS=$'\n\t' | ||
set -vx | ||
bundle install | ||
# Do any other automated setup that you need to do here |
@@ -0,0 +1,36 @@ | ||
lib = File.expand_path("../lib", __FILE__) | ||
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) | ||
require "borg/reducer/version" | ||
Gem::Specification.new do |spec| | ||
spec.name = "borg-reducer" | ||
spec.version = Borg::Reducer::VERSION | ||
spec.authors = ["Ryan Deschamps"] | ||
spec.email = ["ryan.deschamps@gmail.com"] | ||
spec.summary = %q{TODO: Write a short summary, because RubyGems requires one.} | ||
spec.description = %q{TODO: Write a longer description or delete this line.} | ||
spec.homepage = "TODO: Put your gem's website or public repo URL here." | ||
spec.license = "MIT" | ||
# Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host' | ||
# to allow pushing to a single host or delete this section to allow pushing to any host. | ||
if spec.respond_to?(:metadata) | ||
spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'" | ||
else | ||
raise "RubyGems 2.0 or newer is required to protect against " \ | ||
"public gem pushes." | ||
end | ||
spec.files = `git ls-files -z`.split("\x0").reject do |f| | ||
f.match(%r{^(test|spec|features)/}) | ||
end | ||
spec.bindir = "exe" | ||
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) } | ||
spec.require_paths = ["lib"] | ||
spec.add_development_dependency "bundler", "~> 1.16" | ||
spec.add_development_dependency "rake", "~> 10.0" | ||
spec.add_development_dependency "minitest", "~> 5.0" | ||
end |
@@ -0,0 +1,7 @@ | ||
require "borg/reducer/version" | ||
module Borg | ||
module Reducer | ||
# Your code goes here... | ||
end | ||
end |
@@ -0,0 +1,5 @@ | ||
module Borg | ||
module Reducer | ||
VERSION = "0.1.0" | ||
end | ||
end |
@@ -0,0 +1,11 @@ | ||
require "test_helper" | ||
class Borg::ReducerTest < Minitest::Test | ||
def test_that_it_has_a_version_number | ||
refute_nil ::Borg::Reducer::VERSION | ||
end | ||
def test_it_does_something_useful | ||
assert false | ||
end | ||
end |
@@ -0,0 +1,4 @@ | ||
$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__) | ||
require "borg/reducer" | ||
require "minitest/autorun" |
0 comments on commit
7b01df2