rsgem 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f0622fb3d78fdde2291dddba96eb5ec6dbebc8be9bf32187a6c76374c48a4428
+  data.tar.gz: 926cbc4d4003bb8c214a4894def1325b596487e0e73c21a0247df10bbf8ad0dd
+SHA512:
+  metadata.gz: 5b429ae00a6454f4f110576467bb556913db2b0c870075bff02d1bb7ad0c41ed0eb8e8158727b31c1bac8e1abc90fdf13a1ead4b8ce858b8d154cf1bfa0a67f3
+  data.tar.gz: 8b41cbcf3c7e1ef59db574885631201fd85ee745b986b9e4bba2b7aacc55d71edfb2ee2422d66a2faf5c93d22c9ab53932e9fe743e6b950c45d8fbc7a6cbee3c

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Juan Manuel Ramallo
+
+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,84 @@
+# `rsgem` - Rootstrap's gem generator
+
+![build](https://github.com/rootstrap/rsgem/workflows/build/badge.svg)
+[![Maintainability](https://api.codeclimate.com/v1/badges/c22da1693543a6eac7e9/maintainability)](https://codeclimate.com/github/rootstrap/rsgem/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/c22da1693543a6eac7e9/test_coverage)](https://codeclimate.com/github/rootstrap/rsgem/test_coverage)
+
+`rsgem` is a tool to help you start developing gems with the defaults we use at Rootstrap.
+
+## Installation
+
+    $ gem install rsgem
+
+We highly suggest to not include `rsgem` in your Gemfile.
+`rsgem` is not a library, and should not affect the dependency tree of your application.
+
+## Usage
+
+```
+rsgem new NAME [CI_PROVIDER]
+```
+
+RSGem will solve the following tasks for you:
+
+1. Create a folder for your gem leveraging bundler's defaults. (You need bundler in your system)
+1. Add the following dependencies:
+    - [Rake](https://github.com/ruby/rake)
+    - [Reek](https://github.com/troessner/reek)
+    - [RSpec](https://github.com/rspec/rspec)
+    - [Rubocop](https://github.com/rubocop-hq/rubocop)
+    - [Simplecov](https://github.com/colszowka/simplecov)
+        - We use Simplecov at 0.17.1 because that's the latest compatible version with CodeClimate.
+1. Add configuration files for Reek and Rubocop with default Rootstrap's configuration.
+1. Add a rake task to run Rubocop and Reek by calling `rake code_analysis`.
+1. [Clean the Gemfile](https://github.com/rootstrap/tech-guides/blob/master/open-source/developing_gems.md#gemfilegemfilelockgemspec).
+1. [Git ignore the Gemfile.lock](https://github.com/rootstrap/tech-guides/blob/master/open-source/developing_gems.md#gemfilegemfilelockgemspec)
+1. Add a CI provider configuration. GitHub Actions and Travis are available providers. Travis is the default.
+1. Set the bundled files to be a short list of files. By default the gem will bundle:
+    - LICENSE.txt
+    - README.md
+    - lib/**/* (everything inside lib)
+1. Apply Rubocop style fixes
+
+#### Examples
+
+```
+rsgem new foo
+```
+Creates a new gem called foo.
+
+```
+rsgem new bar github_actions
+```
+Creates a new gem called bar that uses Github Actions as the CI provider.
+
+#### Help
+
+```
+rsgem -h
+```
+Displays global help.
+
+```
+rsgem new -h
+```
+Displays help for the `new` command.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` 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/rootstrap/rsgem. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/rootstrap/rsgem/blob/master/CODE_OF_CONDUCT.md).
+
+
+## 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 Rootstrap project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rootstrap/rsgem/blob/master/CODE_OF_CONDUCT.md).

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'rsgem'
+
+# 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__)

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/exe/rsgem

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'rsgem'
+
+Dry::CLI.new(RSGem::CLI::Commands).call

data/lib/rsgem/ci_providers/base.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RSGem
+  module CIProviders
+    class Base
+      attr_reader :config_file_destination, :config_file_source, :name, :display_name
+
+      def initialize(config_file_source: nil, config_file_destination: nil, display_name:, name:)
+        @config_file_source = config_file_source
+        @config_file_destination = config_file_destination
+        @display_name = display_name
+        @name = name
+      end
+
+      def install(context)
+        destination = "#{context.folder_path}/#{config_file_destination}"
+
+        File.delete(destination) if File.exist?(destination)
+        FileUtils.mkdir_p(File.dirname(destination))
+        File.open(destination, 'w') do |file|
+          file.puts config_file_source_content
+        end
+
+        puts "\t#{display_name} CI configuration added"
+      end
+
+      private
+
+      def config_file_source_content
+        File.read(config_file_source)
+      end
+    end
+  end
+end

data/lib/rsgem/ci_providers/github_actions.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module RSGem
+  module CIProviders
+    GithubActions = Base.new(
+      config_file_source: "#{File.dirname(__FILE__)}/../support/github_actions.yml",
+      config_file_destination: '.github/workflows/ci.yml',
+      display_name: 'Github Actions',
+      name: 'github_actions'
+    )
+  end
+end

data/lib/rsgem/ci_providers/travis.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module RSGem
+  module CIProviders
+    Travis = Base.new(config_file_source: "#{File.dirname(__FILE__)}/../support/travis.yml",
+                      config_file_destination: '.travis.yml',
+                      display_name: 'Travis',
+                      name: 'travis')
+  end
+end

data/lib/rsgem/cli/commands/new.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RSGem
+  module CLI
+    module Commands
+      class New < Dry::CLI::Command
+        def self.ci_provider_options
+          RSGem::Constants::CI_PROVIDERS.map { |ci| "'#{ci.name}'" }.join(', ')
+        end
+
+        desc 'Create a new gem'
+
+        argument :gem_name, type: :string, required: true, desc: 'Name of your new gem'
+        argument :ci_provider, type: :string, required: false,
+                               desc: 'CI provider to use. '\
+                                     "Available options are: #{ci_provider_options}. "\
+                                     "Default option is 'travis'"
+
+        example [
+          'foo                # Creates a new gem called foo',
+          'bar github_actions # Creates a new gem called bar, with GitHub Actions as the '\
+          'CI provider'
+        ]
+
+        def call(**options)
+          RSGem::Gem.new(gem_name: options[:gem_name], ci_provider: options[:ci_provider]).create
+        end
+      end
+    end
+  end
+end

data/lib/rsgem/cli/commands/version.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RSGem
+  module CLI
+    module Commands
+      class Version < Dry::CLI::Command
+        desc 'Print version'
+
+        def call(*)
+          puts RSGem::VERSION
+        end
+      end
+    end
+  end
+end

data/lib/rsgem/cli/commands.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module RSGem
+  module CLI
+    module Commands
+      extend Dry::CLI::Registry
+
+      register 'new', New
+      register 'version', Version, aliases: ['v', '-v', '--version']
+    end
+  end
+end

data/lib/rsgem/constants.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RSGem
+  module Constants
+    CI_PROVIDERS = [
+      RSGem::CIProviders::GithubActions,
+      RSGem::CIProviders::Travis
+    ].freeze
+    DEFAULT_CI_PROVIDER = RSGem::CIProviders::Travis
+  end
+end

data/lib/rsgem/context.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RSGem
+  class Context
+    attr_reader :options
+
+    def initialize(options:)
+      @options = options
+
+      raise MissingGemNameError unless options[:gem_name]
+    end
+
+    def ci_provider
+      @ci_provider ||= begin
+        return RSGem::Constants::DEFAULT_CI_PROVIDER unless (name = options[:ci_provider])
+
+        RSGem::Constants::CI_PROVIDERS.detect do |provider|
+          provider.name == name
+        end
+      end
+    end
+
+    def gemfile_path
+      "#{folder_path}/Gemfile"
+    end
+
+    def gem_name
+      @gem_name ||= options[:gem_name]
+    end
+
+    def gemspec_path
+      "#{folder_path}/#{gem_name}.gemspec"
+    end
+
+    def folder_path
+      `pwd`.sub("\n", '/') + gem_name
+    end
+
+    def gitignore_path
+      "#{folder_path}/.gitignore"
+    end
+
+    def rakefile_path
+      "#{folder_path}/Rakefile"
+    end
+  end
+end

data/lib/rsgem/dependencies/base.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RSGem
+  module Dependencies
+    class Base
+      attr_reader :config_file_destination, :config_file_source, :mode, :name, :version
+
+      def initialize(config_file_source: nil, config_file_destination: nil, mode: :development,
+                     name:, version: nil)
+        @config_file_source = config_file_source
+        @config_file_destination = config_file_destination
+        @mode = mode # Either `development' or `runtime'
+        @name = name
+        @version = version ? "'#{version}'" : nil
+      end
+
+      def install(context)
+        if config_file_source
+          File.open("#{context.folder_path}/#{config_file_destination}", 'w') do |file|
+            file.puts config_file_source_content
+          end
+        end
+
+        puts "\t#{name.capitalize} installed"
+      end
+
+      private
+
+      def config_file_source_content
+        File.read(config_file_source)
+      end
+    end
+  end
+end

data/lib/rsgem/dependencies/rake.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RSGem
+  module Dependencies
+    Rake = Base.new(name: 'rake')
+  end
+end

data/lib/rsgem/dependencies/reek.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RSGem
+  module Dependencies
+    Reek = Base.new(
+      config_file_source: "#{File.dirname(__FILE__)}/../support/reek.yml",
+      config_file_destination: '.reek.yml',
+      name: 'reek'
+    )
+  end
+end

data/lib/rsgem/dependencies/rspec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RSGem
+  module Dependencies
+    RSpec = Base.new(name: 'rspec')
+  end
+end

data/lib/rsgem/dependencies/rubocop.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RSGem
+  module Dependencies
+    Rubocop = Base.new(
+      config_file_source: "#{File.dirname(__FILE__)}/../support/rubocop.yml",
+      config_file_destination: '.rubocop.yml',
+      name: 'rubocop'
+    )
+  end
+end

data/lib/rsgem/dependencies/simplecov.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RSGem
+  module Dependencies
+    # This is the latest stable version working correctly with codeclimate
+    # 0.18+ does not work currently https://github.com/codeclimate/test-reporter/issues/413
+    Simplecov = Base.new(name: 'simplecov', version: '~> 0.17.1')
+  end
+end

data/lib/rsgem/errors/missing_gem_name_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module RSGem
+  class MissingGemNameError < StandardError
+  end
+end

data/lib/rsgem/gem.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module RSGem
+  class Gem
+    attr_reader :options
+
+    def initialize(options)
+      @options = options
+    end
+
+    def create
+      `bundle gem #{context.gem_name}`
+
+      add_code_analysis
+      add_dependencies
+      clean_gemfile
+      ignore_gemfile_lock
+      add_ci_provider
+      clean_gemspec
+      set_bundled_files
+      run_rubocop
+    end
+
+    private
+
+    def add_ci_provider
+      context.ci_provider.install(context)
+    end
+
+    def add_code_analysis
+      Tasks::AddCodeAnalysis.new(context: context).add
+    end
+
+    def add_dependencies
+      [
+        Dependencies::Rake,
+        Dependencies::Reek,
+        Dependencies::RSpec,
+        Dependencies::Rubocop,
+        Dependencies::Simplecov
+      ].each do |dependency|
+        Tasks::AddDependency.new(context: context, dependency: dependency).add
+      end
+    end
+
+    def clean_gemfile
+      Tasks::CleanGemfile.new(context: context).clean
+    end
+
+    def clean_gemspec
+      Tasks::CleanGemspec.new(context: context).clean
+    end
+
+    def context
+      @context ||= Context.new(options: options)
+    end
+
+    def ignore_gemfile_lock
+      Tasks::IgnoreGemfileLock.new(context: context).ignore
+    end
+
+    def run_rubocop
+      Tasks::RunRubocop.new(context: context).run
+    end
+
+    def set_bundled_files
+      Tasks::SetBundledFiles.new(context: context).set
+    end
+  end
+end

data/lib/rsgem/support/Rakefile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+task :code_analysis do
+  sh 'bundle exec rubocop lib spec'
+  sh 'bundle exec reek lib'
+end

data/lib/rsgem/support/github_actions.yml

@@ -0,0 +1,36 @@
+name: ci
+
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby_version: [2.5.x, 2.6.x, 2.7.x]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby_version }}
+    - name: Download CodeClimate reporter
+      run: |
+        curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+        chmod +x ./cc-test-reporter
+        ./cc-test-reporter before-build
+      env:
+        CC_TEST_REPORTER_ID: get_a_test_reporter_id_from_code_climate
+    - name: Build and test
+      run: |
+        gem install bundler:1.17.3
+        bundle update
+        bundle install --jobs 4 --retry 3
+        bundle exec rake code_analysis
+        bundle exec rspec
+    - name: Report to CodeClimate
+      run: |
+        ./cc-test-reporter after-build --exit-code 0
+      env:
+        CC_TEST_REPORTER_ID: get_a_test_reporter_id_from_code_climate

data/lib/rsgem/support/reek.yml

@@ -0,0 +1,127 @@
+detectors:
+  Attribute:
+    enabled: false
+    exclude: []
+  BooleanParameter:
+    enabled: true
+    exclude: []
+  ClassVariable:
+    enabled: false
+    exclude: []
+  ControlParameter:
+    enabled: true
+    exclude: []
+  DataClump:
+    enabled: true
+    exclude: []
+    max_copies: 2
+    min_clump_size: 2
+  DuplicateMethodCall:
+    enabled: true
+    exclude: []
+    max_calls: 1
+    allow_calls: []
+  FeatureEnvy:
+    enabled: true
+    exclude: []
+  InstanceVariableAssumption:
+    enabled: false
+  IrresponsibleModule:
+    enabled: false
+    exclude: []
+  LongParameterList:
+    enabled: true
+    exclude: []
+    max_params: 4
+    overrides:
+      initialize:
+        max_params: 5
+  LongYieldList:
+    enabled: true
+    exclude: []
+    max_params: 3
+  ManualDispatch:
+    enabled: true
+    exclude: []
+  MissingSafeMethod:
+    enabled: false
+    exclude: []
+  ModuleInitialize:
+    enabled: true
+    exclude: []
+  NestedIterators:
+    enabled: true
+    exclude: []
+    max_allowed_nesting: 2
+    ignore_iterators: []
+  NilCheck:
+    enabled: false
+    exclude: []
+  RepeatedConditional:
+    enabled: true
+    exclude: []
+    max_ifs: 3
+  SubclassedFromCoreClass:
+    enabled: true
+    exclude: []
+  TooManyConstants:
+    enabled: true
+    exclude: []
+    max_constants: 5
+  TooManyInstanceVariables:
+    enabled: true
+    exclude: []
+    max_instance_variables: 9
+  TooManyMethods:
+    enabled: true
+    exclude: []
+    max_methods: 25
+  TooManyStatements:
+    enabled: true
+    exclude:
+      - initialize
+    max_statements: 12
+  UncommunicativeMethodName:
+    enabled: true
+    exclude: []
+    reject:
+      - "/^[a-z]$/"
+      - "/[0-9]$/"
+      - "/[A-Z]/"
+    accept: []
+  UncommunicativeModuleName:
+    enabled: true
+    exclude: []
+    reject:
+      - "/^.$/"
+      - "/[0-9]$/"
+    accept:
+      - Inline::C
+      - "/V[0-9]/"
+  UncommunicativeParameterName:
+    enabled: true
+    exclude: []
+    reject:
+      - "/^.$/"
+      - "/[0-9]$/"
+      - "/[A-Z]/"
+    accept: []
+  UncommunicativeVariableName:
+    enabled: true
+    exclude: []
+    reject:
+      - "/^.$/"
+      - "/[0-9]$/"
+      - "/[A-Z]/"
+    accept:
+      - _
+  UnusedParameters:
+    enabled: true
+    exclude: []
+  UnusedPrivateMethod:
+    enabled: false
+  UtilityFunction:
+    enabled: false
+
+exclude_paths:
+  - config

data/lib/rsgem/support/rubocop.yml

@@ -0,0 +1,81 @@
+Style/Documentation:
+  Enabled: false
+
+Layout/SpaceBeforeFirstArg:
+  Exclude:
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - spec/**/*
+
+Metrics/AbcSize:
+  # The ABC size is a calculated magnitude, so this number can be an Integer or
+  # a Float.
+  Max: 15
+
+Metrics/BlockLength:
+  CountComments: false
+  Max: 25
+  Exclude:
+    - '*.gemspec'
+    - config/**/*
+    - spec/**/*
+  ExcludedMethods:
+    - class_methods
+
+Metrics/BlockNesting:
+  Max: 4
+
+Metrics/ClassLength:
+  CountComments: false
+  Max: 200
+
+# Avoid complex methods.
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+Metrics/MethodLength:
+  CountComments: false
+  Max: 24
+
+Metrics/ModuleLength:
+  CountComments: false
+  Max: 200
+
+Layout/LineLength:
+  Max: 100
+  # To make it possible to copy or click on URIs in the code, we allow lines
+  # containing a URI to be longer than Max.
+  AllowURI: true
+  URISchemes:
+    - http
+    - https
+
+Metrics/ParameterLists:
+  Max: 5
+  CountKeywordArgs: true
+
+Metrics/PerceivedComplexity:
+  Max: 12
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+Style/ModuleFunction:
+  Enabled: false
+
+Style/RescueModifier:
+  Exclude:
+    - spec/**/*
+
+Naming/PredicateName:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true

data/lib/rsgem/support/travis.yml

@@ -0,0 +1,28 @@
+language: ruby
+
+rvm:
+  - 2.5.0
+  - 2.6.0
+  - ruby-head
+
+dist: bionic
+
+jobs:
+  allow_failures:
+    - rvm: ruby-head
+
+env:
+  global:
+    - CC_TEST_REPORTER_ID=get_a_test_reporter_id_from_code_climate
+
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+
+script:
+  - bundle exec rake code_analysis
+  - bundle exec rspec
+
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/lib/rsgem/tasks/add_code_analysis.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module RSGem
+  module Tasks
+    class AddCodeAnalysis
+      attr_reader :context
+
+      def initialize(context:)
+        @context = context
+      end
+
+      def add
+        File.open(context.rakefile_path, 'w') do |file|
+          file.puts rakefile
+        end
+      end
+
+      private
+
+      def rakefile
+        @rakefile ||= File.read("#{File.dirname(__FILE__)}/../support/Rakefile")
+      end
+    end
+  end
+end

data/lib/rsgem/tasks/add_dependency.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module RSGem
+  module Tasks
+    class AddDependency
+      attr_reader :context, :dependency
+
+      def initialize(context:, dependency:)
+        @context = context
+        @dependency = dependency
+      end
+
+      def add
+        return if already_installed?
+
+        add_dependency
+        write_to_gemspec
+        dependency.install(context)
+      end
+
+      private
+
+      def add_dependency
+        gemspec_file.gsub!(/end\n\z/, code)
+        gemspec_file << "\nend"
+      end
+
+      def already_installed?
+        gemspec_file.match? Regexp.new("('|\")#{dependency.name}('|\")")
+      end
+
+      def code
+        text = ["  spec.add_#{dependency.mode}_dependency '#{dependency.name}'", dependency.version]
+        text.compact.join(', ')
+      end
+
+      def gemspec_file
+        @gemspec_file ||= File.read(context.gemspec_path)
+      end
+
+      def write_to_gemspec
+        File.open(context.gemspec_path, 'w') do |file|
+          file.puts gemspec_file
+        end
+      end
+    end
+  end
+end

data/lib/rsgem/tasks/clean_gemfile.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module RSGem
+  module Tasks
+    #
+    # Gemfile should only have the gemspec directive.
+    # An exception is when you need to develop against a gem that hasn't yet been released,
+    # in this case you can declare that dependency in the Gemfile:
+    #
+    #   gem 'rack', github: 'rack/rack'
+    #
+    # gemspec is the place to declare dependencies.
+    #
+    # https://github.com/rootstrap/tech-guides/blob/master/open-source/developing_gems.md#gemfilegemfilelockgemspec
+    #
+    class CleanGemfile
+      attr_reader :context
+
+      def initialize(context:)
+        @context = context
+      end
+
+      def clean
+        gemfile.gsub!(/gem .+\n/, '') # Remove all gem definitions
+        gemfile.sub!(/\n\z/, '') # Remove last new line character
+        write_to_gemfile
+        puts "\tGemfile cleaned"
+      end
+
+      private
+
+      def gemfile
+        @gemfile ||= File.read(context.gemfile_path)
+      end
+
+      def write_to_gemfile
+        File.open(context.gemfile_path, 'w') do |file|
+          file.puts gemfile
+        end
+      end
+    end
+  end
+end

data/lib/rsgem/tasks/clean_gemspec.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module RSGem
+  module Tasks
+    class CleanGemspec
+      attr_reader :context
+
+      KEYS_TO_EMPTY = %w[summary description homepage].freeze
+
+      def initialize(context:)
+        @context = context
+      end
+
+      def clean
+        comment_metadata!
+        empty_keys!
+        write
+      end
+
+      private
+
+      def gemspec
+        @gemspec ||= File.read(context.gemspec_path)
+      end
+
+      def empty_keys!
+        KEYS_TO_EMPTY.each do |key|
+          gemspec.gsub!(/(spec.#{key}.*)=(.*)\n/, "\\1= ''\n")
+        end
+      end
+
+      def comment_metadata!
+        gemspec.gsub!(/spec.metadata/, '# spec.metadata')
+      end
+
+      def write
+        File.open(context.gemspec_path, 'w') do |file|
+          file.puts gemspec
+        end
+      end
+    end
+  end
+end

data/lib/rsgem/tasks/ignore_gemfile_lock.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module RSGem
+  module Tasks
+    #
+    # Gemfile.lock should be gitignored when developing gems
+    #
+    # https://github.com/rootstrap/tech-guides/blob/master/open-source/developing_gems.md#gemfilegemfilelockgemspec
+    #
+    class IgnoreGemfileLock
+      attr_reader :context
+
+      def initialize(context:)
+        @context = context
+      end
+
+      def ignore
+        gitignore << "\nGemfile.lock\n"
+        write_to_gitignore
+        puts "\tGemfile.lock added to .gitignore"
+      end
+
+      private
+
+      def gitignore
+        @gitignore ||= File.read(context.gitignore_path)
+      end
+
+      def write_to_gitignore
+        File.open(context.gitignore_path, 'w') do |file|
+          file.puts gitignore
+        end
+      end
+    end
+  end
+end

data/lib/rsgem/tasks/run_rubocop.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module RSGem
+  module Tasks
+    class RunRubocop
+      attr_reader :context, :output
+
+      def initialize(context:)
+        @context = context
+      end
+
+      def run
+        puts "\tRubocop:"
+        @output = `cd #{context.folder_path} && bundle exec rubocop -a`
+        puts "\t\t#{last_line}"
+      end
+
+      private
+
+      def last_line
+        @output.split("\n").last
+      end
+    end
+  end
+end

data/lib/rsgem/tasks/set_bundled_files.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module RSGem
+  module Tasks
+    #
+    # When the gem is bundled into final users' projects, it only needs to contain the production
+    # code. Meaning that specs, docs, configuration files should not be present.
+    # This task updates the default `spec.files` configuration in the gemspec to just contain the
+    # files:
+    #   - LICENSE.txt
+    #   - README.md
+    #   - lib/**/* (everything inside lib)
+    #
+    class SetBundledFiles
+      attr_reader :context
+
+      def initialize(context:)
+        @context = context
+      end
+
+      def set
+        # Explaining the regular expression:
+        # [spec.files][one or more white spaces][=][one or more white spaces][anything until "do"]
+        #   [new line][anything until new line]
+        # [one or more white spaces][end]
+        gemspec.gsub!(
+          /spec.files\s+=\s+.+do\n.+\n\s+end/,
+          "spec.files = Dir['LICENSE.txt', 'README.md', 'lib/**/*']"
+        )
+        write
+
+        puts "\tGemspec files config updated"
+      end
+
+      private
+
+      def gemspec
+        @gemspec ||= File.read(context.gemspec_path)
+      end
+
+      def write
+        File.open(context.gemspec_path, 'w') do |file|
+          file.puts gemspec
+        end
+      end
+    end
+  end
+end

data/lib/rsgem/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module RSGem
+  MAJOR = 0
+  MINOR = 1
+  PATCH = 0
+  VERSION = [MAJOR, MINOR, PATCH].join('.')
+end

data/lib/rsgem.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'rsgem/version'
+require 'rsgem/gem'
+require 'rsgem/errors/missing_gem_name_error'
+require 'rsgem/ci_providers/base'
+require 'rsgem/ci_providers/github_actions'
+require 'rsgem/ci_providers/travis'
+require 'rsgem/tasks/add_code_analysis'
+require 'rsgem/tasks/add_dependency'
+require 'rsgem/tasks/clean_gemfile'
+require 'rsgem/tasks/ignore_gemfile_lock'
+require 'rsgem/tasks/clean_gemspec'
+require 'rsgem/tasks/run_rubocop'
+require 'rsgem/tasks/set_bundled_files'
+require 'rsgem/dependencies/base'
+require 'rsgem/dependencies/rake'
+require 'rsgem/dependencies/reek'
+require 'rsgem/dependencies/rspec'
+require 'rsgem/dependencies/rubocop'
+require 'rsgem/dependencies/simplecov'
+require 'rsgem/constants'
+require 'rsgem/context'
+require 'dry/cli'
+require 'rsgem/cli/commands/new'
+require 'rsgem/cli/commands/version'
+require 'rsgem/cli/commands'
+
+module RSGem
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: rsgem
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Juan Manuel Ramallo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.6.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.80.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.80.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+description: 
+email:
+- ramallojuanm@gmail.com
+executables:
+- rsgem
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- bin/console
+- bin/setup
+- exe/rsgem
+- lib/rsgem.rb
+- lib/rsgem/ci_providers/base.rb
+- lib/rsgem/ci_providers/github_actions.rb
+- lib/rsgem/ci_providers/travis.rb
+- lib/rsgem/cli/commands.rb
+- lib/rsgem/cli/commands/new.rb
+- lib/rsgem/cli/commands/version.rb
+- lib/rsgem/constants.rb
+- lib/rsgem/context.rb
+- lib/rsgem/dependencies/base.rb
+- lib/rsgem/dependencies/rake.rb
+- lib/rsgem/dependencies/reek.rb
+- lib/rsgem/dependencies/rspec.rb
+- lib/rsgem/dependencies/rubocop.rb
+- lib/rsgem/dependencies/simplecov.rb
+- lib/rsgem/errors/missing_gem_name_error.rb
+- lib/rsgem/gem.rb
+- lib/rsgem/support/Rakefile
+- lib/rsgem/support/github_actions.yml
+- lib/rsgem/support/reek.yml
+- lib/rsgem/support/rubocop.yml
+- lib/rsgem/support/travis.yml
+- lib/rsgem/tasks/add_code_analysis.rb
+- lib/rsgem/tasks/add_dependency.rb
+- lib/rsgem/tasks/clean_gemfile.rb
+- lib/rsgem/tasks/clean_gemspec.rb
+- lib/rsgem/tasks/ignore_gemfile_lock.rb
+- lib/rsgem/tasks/run_rubocop.rb
+- lib/rsgem/tasks/set_bundled_files.rb
+- lib/rsgem/version.rb
+homepage: https://github.com/rootstrap/rsgem
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rootstrap/rsgem
+  source_code_uri: https://github.com/rootstrap/rsgem
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Generating gems the Rootstrap way
+test_files: []