contributor_covenant 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3bb9b89f2c51dd3007799ad89bc92a21bc0dcfdcdd7e57aa59527739d00db735
+  data.tar.gz: e2687da6e0b2976f2452925d8734be5e88eb63c38494d34f047707721f394a4b
+SHA512:
+  metadata.gz: 8e49998aaa69d5f5f4ff8781d8a7c0f7a5f13ada7d5005129396a11db165f0d942b3205f2b09cf618e70bb0a5c966b4cfa3ef3415e41e0aaecae85bfba5445da
+  data.tar.gz: 1830dc659b4e24f975468a5f24a1935896703253fe3aa7d93ced8d01747c23a6f94162f5ec00e5de65f7635e6569188e523fda5f3dddf938c9e3b78f97732d84

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,82 @@
+AllCops:
+  TargetRubyVersion: 2.5.3
+  Exclude:
+    - "bin/*"
+    - "./**/*.gemspec"
+    - "Gemfile"
+    - "Rakefile"
+    - "vendor/**/*"
+    - "exe/*"
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 21
+  Exclude:
+    - "lib/release/notes/configuration.rb"
+
+Metrics/BlockLength:
+  Max: 40
+  Exclude:
+    - "./**/spec/**/*"
+
+Metrics/AbcSize:
+  Exclude:
+    - "lib/release/notes/configuration.rb"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  Exclude:
+    - Gemfile
+
+Layout/DotPosition:
+  # Multi-line method chaining should be done with trailing dots.
+  EnforcedStyle: trailing
+
+Style/TrailingCommaInArguments:
+  # If `comma`, the cop requires a comma after the last argument, but only for
+  # parenthesized method calls where each argument is on its own line.
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  # If `comma`, the cop requires a comma after the last item in an array,
+  # but only when each item is on its own line.
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  # If `comma`, the cop requires a comma after the last item in a hash,
+  # but only when each item is on its own line.
+  EnforcedStyleForMultiline: comma
+
+Style/MutableConstant:
+  # Do not assign mutable objects to constants.
+  Enabled: false
+
+Style/Documentation:
+  # Document classes and non-namespace modules
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  # Checks style of children classes and modules.
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  # Checks existence of the frozen string literal comment
+  Enabled: true
+
+Style/RescueStandardError:
+  # Checks that you are including the error class
+  # when you rescue
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  # Percent literal delimeters are always parentheses
+  PreferredDelimiters:
+    { default: (),
+    '%i': '()',
+    '%I': '()',
+    '%r': '()',
+    '%w': '()',
+    '%W': '()'
+    }

data/.travis.yml

@@ -0,0 +1,10 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 1.17.2
+script:
+  - bundle exec rspec
+  - bundle exec rubocop

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in contributor_covenant.gemspec
+gemspec
+
+group :test do
+  gem 'codeclimate-test-reporter', require: false
+  gem 'rspec', '~> 3.6.0'
+  gem 'simplecov', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    contributor_covenant (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    codeclimate-test-reporter (1.0.7)
+      simplecov
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    jaro_winkler (1.5.1)
+    json (2.1.0)
+    method_source (0.9.2)
+    parallel (1.12.1)
+    parser (2.5.3.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    rubocop (0.60.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    unicode-display_width (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  codeclimate-test-reporter
+  contributor_covenant!
+  pry (~> 0.12.2)
+  rake (~> 10.0)
+  rspec (~> 3.6.0)
+  rubocop (~> 0.60.0)
+  simplecov
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Andrew Mason
+
+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.

data/README.md

@@ -0,0 +1,39 @@
+# ContributorCovenant
+
+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/contributor_covenant`. 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 'contributor_covenant'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install contributor_covenant
+
+## 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]/contributor_covenant.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+Dir.glob('lib/tasks/*.rake').each { |r| import r }
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "contributor_covenant"
+require "pry"
+
+Pry.start

data/bin/setup

@@ -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

data/bin/test

@@ -0,0 +1,3 @@
+#!/usr/bin/env sh
+
+bundle exec rake spec

data/contributor_covenant.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "contributor_covenant/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "contributor_covenant"
+  spec.version       = ContributorCovenant::VERSION
+  spec.authors       = ["Andrew Mason"]
+  spec.email         = ["masonam96@outlook.com"]
+
+  spec.summary       = "contributor covenant file generator"
+  spec.description   = "automatically generate a contributor covenant for any project"
+  spec.homepage      = "https://github.com/andrewmcodes/contributor_covenant"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "pry", "~> 0.12.2"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rubocop", "~> 0.60.0"
+end

data/lib/contributor_covenant/install.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "rake"
+
+load File.expand_path(File.join(File.dirname(__FILE__), "tasks/install.rake"))

data/lib/contributor_covenant/tasks/install.rake

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+namespace :"contributor_covenant" do
+  desc "Install contributor_covenant in a non Rails environment"
+  task :install do
+    cc_file = File.expand_path("../../../generators/contributor_covenant/install/templates/template.md", __dir__)
+
+    # @TODO: allow to overwrite
+    if File.exist?("./CONTRIBUTOR_COVENANT.md")
+      warn "=> [ skipping ] covenant already exists"
+    else
+      FileUtils.cp(cc_file, "./CONTRIBUTOR_COVENANT.md")
+      warn "=> [ success ] covenant created"
+    end
+  end
+end

data/lib/contributor_covenant/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ContributorCovenant
+  VERSION = "0.1.0"
+end

data/lib/contributor_covenant.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "contributor_covenant/version"
+
+module ContributorCovenant
+  class Error < StandardError; end
+
+  class << self
+    def generate
+      FileUtils.copy("#{copy_from_path}/template.md", "#{copy_to_path}/CONTRIBUTOR_COVENANT.md", preserve: true)
+    end
+
+    def copy_from_path
+      "#{File.expand_path(__dir__)}/generators/contributor_covenant/install/templates"
+    end
+
+    def copy_to_path
+      Dir.pwd
+    end
+
+    def root
+      File.expand_path(__dir__)
+    end
+  end
+end

data/lib/generators/contributor_covenant/install/install_generator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+
+module ContributorCovenant
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      def create_contributor_covenant
+        copy_file "template.md", "CONTRIBUTOR_COVENANT.md"
+      end
+
+      def display_readme
+        readme "README"
+      end
+    end
+  end
+end

data/lib/generators/contributor_covenant/install/templates/README

@@ -0,0 +1,5 @@
+*******************************************************************************
+
+@TODO
+
+*******************************************************************************

data/lib/generators/contributor_covenant/install/templates/template.md

@@ -0,0 +1,76 @@
+# 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, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, 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 [INSERT EMAIL ADDRESS]. 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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/lib/tasks/generate_contributor_covenant.rake

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+namespace :generate_contributor_covenant do
+  task :run do
+    puts "=> Generating Contributor Covenant File..."
+    ContributorCovenant.generate
+    puts "=> Done!"
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: contributor_covenant
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Mason
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.60.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.60.0
+description: automatically generate a contributor covenant for any project
+email:
+- masonam96@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/test
+- contributor_covenant.gemspec
+- lib/contributor_covenant.rb
+- lib/contributor_covenant/install.rb
+- lib/contributor_covenant/tasks/install.rake
+- lib/contributor_covenant/version.rb
+- lib/generators/contributor_covenant/install/install_generator.rb
+- lib/generators/contributor_covenant/install/templates/README
+- lib/generators/contributor_covenant/install/templates/template.md
+- lib/tasks/generate_contributor_covenant.rake
+homepage: https://github.com/andrewmcodes/contributor_covenant
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: contributor covenant file generator
+test_files: []