rsgem 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0622fb3d78fdde2291dddba96eb5ec6dbebc8be9bf32187a6c76374c48a4428
-  data.tar.gz: 926cbc4d4003bb8c214a4894def1325b596487e0e73c21a0247df10bbf8ad0dd
+  metadata.gz: ad493db4ccc39d3453ed0f1dd0d4e4b594809c2c322b8907c187e53a01e33425
+  data.tar.gz: 59855a9d4d9efc2d2d28849bbafa1f172634ae5e9d84ec88d2569e7c0698bdb4
 SHA512:
-  metadata.gz: 5b429ae00a6454f4f110576467bb556913db2b0c870075bff02d1bb7ad0c41ed0eb8e8158727b31c1bac8e1abc90fdf13a1ead4b8ce858b8d154cf1bfa0a67f3
-  data.tar.gz: 8b41cbcf3c7e1ef59db574885631201fd85ee745b986b9e4bba2b7aacc55d71edfb2ee2422d66a2faf5c93d22c9ab53932e9fe743e6b950c45d8fbc7a6cbee3c
+  metadata.gz: 223a728398f98c295676a9ca723149a01668df08582eb686fb4cebac2255cf12ce0e632406836f6d784db474c515523d85fab30049ef142530400280ca7a1e7e
+  data.tar.gz: 26ffb08fe6eea56092c4eca3976e42cde0bdeac8ac3f14b9e15a9aa737819ca4e5430f6f1826c19a29352dc5eb910ecb8679fa33568b4dfa14ca898e4f375237

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# master
+
+# 0.3.0
+
+* Add task to replace system user name in LICENSE.txt with Rootstrap name
+
+    *Juan Francisco Ferrari*
+
+# 0.2.0
+
+* Add default configuration for simplecov in spec_helper.rb
+
+* Display an error message if bundler failed to run or is not present in the system
+
+    *Juan Manuel Ramallo*
+
+# 0.1.3
+
+* Fix gem creation task on Linux
+
+    *Juan Aparicio*

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 Juan Manuel Ramallo
+Copyright (c) 2020 Rootstrap
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,8 +1,9 @@
 # `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)
+[![Gem Version](https://badge.fury.io/rb/rsgem.svg)](https://badge.fury.io/rb/rsgem)
+[![ci](https://github.com/rootstrap/rsgem/workflows/ci/badge.svg)](https://github.com/rootstrap/rsgem/actions?query=workflow%3Aci)
+[![Maintainability](https://api.codeclimate.com/v1/badges/d956ef2db5e9d02db891/maintainability)](https://codeclimate.com/github/rootstrap/rsgem/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/d956ef2db5e9d02db891/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.
 
@@ -11,12 +12,12 @@
     $ 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.
+`rsgem` is not a library, and should not affect the dependency tree of your project.
 
 ## Usage
 
 ```
-rsgem new NAME [CI_PROVIDER]
+rsgem new NAME
 ```
 
 RSGem will solve the following tasks for you:
@@ -48,10 +49,20 @@ rsgem new foo
 Creates a new gem called foo.
 
 ```
-rsgem new bar github_actions
+rsgem new bar --ci=github_actions
 ```
 Creates a new gem called bar that uses Github Actions as the CI provider.
 
+```
+rsgem new foo_bar --bundler=--ext
+```
+Creates a new gem called foo_bar and passes the [--ext flag to bundler](https://bundler.io/v2.0/man/bundle-gem.1.html#OPTIONS).
+
+```
+rsgem new bar_foo --bundler='--several --flags'
+```
+Creates a new gem passing several flags to bundler.
+
 #### Help
 
 ```

data/lib/rsgem.rb

@@ -1,18 +1,24 @@
 # frozen_string_literal: true
 
+require 'date'
 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/base'
 require 'rsgem/tasks/add_code_analysis'
 require 'rsgem/tasks/add_dependency'
 require 'rsgem/tasks/clean_gemfile'
+require 'rsgem/tasks/create_gem'
 require 'rsgem/tasks/ignore_gemfile_lock'
 require 'rsgem/tasks/clean_gemspec'
+require 'rsgem/tasks/bundle_dependencies'
 require 'rsgem/tasks/run_rubocop'
 require 'rsgem/tasks/set_bundled_files'
+require 'rsgem/tasks/set_license_file'
+require 'rsgem/tasks/simple_cov_post_install'
 require 'rsgem/dependencies/base'
 require 'rsgem/dependencies/rake'
 require 'rsgem/dependencies/reek'

data/lib/rsgem/ci_providers/base.rb

@@ -13,6 +13,7 @@ module RSGem
       end
 
       def install(context)
+        remove_travis(context)
         destination = "#{context.folder_path}/#{config_file_destination}"
 
         File.delete(destination) if File.exist?(destination)
@@ -29,6 +30,16 @@ module RSGem
       def config_file_source_content
         File.read(config_file_source)
       end
+
+      #
+      # `bundle gem` adds travis by default
+      #
+      def remove_travis(context)
+        travis_path = "#{context.folder_path}/.travis.yml"
+        return unless File.exist?(travis_path)
+
+        File.delete(travis_path)
+      end
     end
   end
 end

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

@@ -4,26 +4,29 @@ 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'"
+        option :bundler, type: :string,
+                         default: nil,
+                         desc: 'Bundler options to use'
+        option :ci, type: :string,
+                    default: RSGem::Constants::DEFAULT_CI_PROVIDER.name,
+                    values: RSGem::Constants::CI_PROVIDERS.map(&:name),
+                    desc: 'CI provider to use'
 
         example [
-          'foo                # Creates a new gem called foo',
-          'bar github_actions # Creates a new gem called bar, with GitHub Actions as the '\
-          'CI provider'
+          'foo                     # Creates a new gem called foo',
+          'bar --ci=github_actions # Creates a new gem called bar, with GitHub Actions as the '\
+          'CI provider',
+          'foo_bar --bundler=--ext # Creates a new gem called foo_bar passing the --ext flag to '\
+          'bundler'
         ]
 
         def call(**options)
-          RSGem::Gem.new(gem_name: options[:gem_name], ci_provider: options[:ci_provider]).create
+          RSGem::Gem.new(gem_name: options[:gem_name],
+                         ci_provider: options[:ci],
+                         bundler_options: options[:bundler]).create
         end
       end
     end

data/lib/rsgem/context.rb

@@ -10,6 +10,10 @@ module RSGem
       raise MissingGemNameError unless options[:gem_name]
     end
 
+    def bundler_options
+      @bundler_options ||= options[:bundler_options]
+    end
+
     def ci_provider
       @ci_provider ||= begin
         return RSGem::Constants::DEFAULT_CI_PROVIDER unless (name = options[:ci_provider])
@@ -32,6 +36,10 @@ module RSGem
       "#{folder_path}/#{gem_name}.gemspec"
     end
 
+    def license_path
+      "#{folder_path}/LICENSE.txt"
+    end
+
     def folder_path
       `pwd`.sub("\n", '/') + gem_name
     end
@@ -43,5 +51,9 @@ module RSGem
     def rakefile_path
       "#{folder_path}/Rakefile"
     end
+
+    def spec_helper_path
+      "#{folder_path}/spec/spec_helper.rb"
+    end
   end
 end

data/lib/rsgem/dependencies/base.rb

@@ -3,14 +3,16 @@
 module RSGem
   module Dependencies
     class Base
-      attr_reader :config_file_destination, :config_file_source, :mode, :name, :version
+      attr_reader :config_file_destination, :config_file_source, :mode, :name, :post_install_task,
+                  :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'
+      def initialize(name:, **args)
+        @config_file_source = args[:config_file_source]
+        @config_file_destination = args[:config_file_destination]
+        @mode = args[:mode] || 'development' # Either `development' or `runtime'
         @name = name
+        @post_install_task = args[:post_install_task]
+        version = args[:version]
         @version = version ? "'#{version}'" : nil
       end
 
@@ -21,6 +23,8 @@ module RSGem
           end
         end
 
+        post_install_task&.new(context: context)&.perform
+
         puts "\t#{name.capitalize} installed"
       end
 

data/lib/rsgem/dependencies/simplecov.rb

@@ -4,6 +4,7 @@ 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')
+    Simplecov = Base.new(name: 'simplecov', version: '~> 0.17.1',
+                         post_install_task: RSGem::Tasks::SimpleCovPostInstall)
   end
 end

data/lib/rsgem/gem.rb

@@ -9,8 +9,7 @@ module RSGem
     end
 
     def create
-      `bundle gem #{context.gem_name}`
-
+      create_gem
       add_code_analysis
       add_dependencies
       clean_gemfile
@@ -18,6 +17,8 @@ module RSGem
       add_ci_provider
       clean_gemspec
       set_bundled_files
+      set_license_file
+      bundle_dependencies
       run_rubocop
     end
 
@@ -28,7 +29,7 @@ module RSGem
     end
 
     def add_code_analysis
-      Tasks::AddCodeAnalysis.new(context: context).add
+      Tasks::AddCodeAnalysis.new(context: context).perform
     end
 
     def add_dependencies
@@ -39,32 +40,44 @@ module RSGem
         Dependencies::Rubocop,
         Dependencies::Simplecov
       ].each do |dependency|
-        Tasks::AddDependency.new(context: context, dependency: dependency).add
+        Tasks::AddDependency.new(context: context, dependency: dependency).perform
       end
     end
 
     def clean_gemfile
-      Tasks::CleanGemfile.new(context: context).clean
+      Tasks::CleanGemfile.new(context: context).perform
     end
 
     def clean_gemspec
-      Tasks::CleanGemspec.new(context: context).clean
+      Tasks::CleanGemspec.new(context: context).perform
     end
 
     def context
       @context ||= Context.new(options: options)
     end
 
+    def create_gem
+      Tasks::CreateGem.new(context: context).perform
+    end
+
     def ignore_gemfile_lock
-      Tasks::IgnoreGemfileLock.new(context: context).ignore
+      Tasks::IgnoreGemfileLock.new(context: context).perform
     end
 
     def run_rubocop
-      Tasks::RunRubocop.new(context: context).run
+      Tasks::RunRubocop.new(context: context).perform
+    end
+
+    def bundle_dependencies
+      Tasks::BundleDependencies.new(context: context).perform
     end
 
     def set_bundled_files
-      Tasks::SetBundledFiles.new(context: context).set
+      Tasks::SetBundledFiles.new(context: context).perform
+    end
+
+    def set_license_file
+      Tasks::SetLicenseFile.new(context: context).perform
     end
   end
 end

data/lib/rsgem/support/rubocop.yml

@@ -4,10 +4,19 @@ Style/Documentation:
 Layout/SpaceBeforeFirstArg:
   Exclude:
 
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
 Lint/AmbiguousBlockAssociation:
   Exclude:
     - spec/**/*
 
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
 Metrics/AbcSize:
   # The ABC size is a calculated magnitude, so this number can be an Integer or
   # a Float.
@@ -58,6 +67,9 @@ Metrics/ParameterLists:
 Metrics/PerceivedComplexity:
   Max: 12
 
+Style/ExponentialNotation:
+  Enabled: true
+
 Style/FrozenStringLiteralComment:
   Enabled: true
 

data/lib/rsgem/tasks/add_code_analysis.rb

@@ -2,14 +2,8 @@
 
 module RSGem
   module Tasks
-    class AddCodeAnalysis
-      attr_reader :context
-
-      def initialize(context:)
-        @context = context
-      end
-
-      def add
+    class AddCodeAnalysis < Base
+      def perform
         File.open(context.rakefile_path, 'w') do |file|
           file.puts rakefile
         end

data/lib/rsgem/tasks/add_dependency.rb

@@ -2,15 +2,8 @@
 
 module RSGem
   module Tasks
-    class AddDependency
-      attr_reader :context, :dependency
-
-      def initialize(context:, dependency:)
-        @context = context
-        @dependency = dependency
-      end
-
-      def add
+    class AddDependency < Base
+      def perform
         return if already_installed?
 
         add_dependency
@@ -34,6 +27,10 @@ module RSGem
         text.compact.join(', ')
       end
 
+      def dependency
+        args[:dependency]
+      end
+
       def gemspec_file
         @gemspec_file ||= File.read(context.gemspec_path)
       end

data/lib/rsgem/tasks/base.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RSGem
+  module Tasks
+    #
+    # Base class for task objects.
+    # Child classes must implement the instance method +perform+.
+    #
+    class Base
+      attr_reader :context, :args
+
+      def initialize(context:, **args)
+        @context = context
+        @args = args
+      end
+    end
+  end
+end

data/lib/rsgem/tasks/bundle_dependencies.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module RSGem
+  module Tasks
+    class BundleDependencies < Base
+      def perform
+        puts "\tRunning bundle install:"
+        @output = `cd #{context.folder_path} && bundle`
+        puts "\t\t#{last_line}"
+      end
+
+      private
+
+      def last_line
+        @output.split("\n").last
+      end
+    end
+  end
+end

data/lib/rsgem/tasks/clean_gemfile.rb

@@ -13,14 +13,8 @@ module RSGem
     #
     # 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
+    class CleanGemfile < Base
+      def perform
         gemfile.gsub!(/gem .+\n/, '') # Remove all gem definitions
         gemfile.sub!(/\n\z/, '') # Remove last new line character
         write_to_gemfile

data/lib/rsgem/tasks/clean_gemspec.rb

@@ -2,16 +2,10 @@
 
 module RSGem
   module Tasks
-    class CleanGemspec
-      attr_reader :context
-
+    class CleanGemspec < Base
       KEYS_TO_EMPTY = %w[summary description homepage].freeze
 
-      def initialize(context:)
-        @context = context
-      end
-
-      def clean
+      def perform
         comment_metadata!
         empty_keys!
         write

data/lib/rsgem/tasks/create_gem.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RSGem
+  module Tasks
+    class CreateGem < Base
+      def perform
+        if system(shell_command)
+          puts message
+        else
+          puts "Failed to run `bundle gem'. "\
+               "Check bundler is installed in your system, or install it with `gem install bundler'"
+          exit false
+        end
+      end
+
+      private
+
+      def bundler_options
+        context.bundler_options
+      end
+
+      def message
+        [
+          "\tGem created",
+          ("with options: #{bundler_options}" if bundler_options)
+        ].compact.join(' ')
+      end
+
+      def shell_command
+        [
+          "bundle gem #{context.gem_name} --test=rspec --coc --mit",
+          bundler_options
+        ].compact.join(' ')
+      end
+    end
+  end
+end

data/lib/rsgem/tasks/ignore_gemfile_lock.rb

@@ -7,14 +7,8 @@ module RSGem
     #
     # 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
+    class IgnoreGemfileLock < Base
+      def perform
         gitignore << "\nGemfile.lock\n"
         write_to_gitignore
         puts "\tGemfile.lock added to .gitignore"

data/lib/rsgem/tasks/run_rubocop.rb

@@ -2,14 +2,8 @@
 
 module RSGem
   module Tasks
-    class RunRubocop
-      attr_reader :context, :output
-
-      def initialize(context:)
-        @context = context
-      end
-
-      def run
+    class RunRubocop < Base
+      def perform
         puts "\tRubocop:"
         @output = `cd #{context.folder_path} && bundle exec rubocop -a`
         puts "\t\t#{last_line}"

data/lib/rsgem/tasks/set_bundled_files.rb

@@ -11,14 +11,8 @@ module RSGem
     #   - README.md
     #   - lib/**/* (everything inside lib)
     #
-    class SetBundledFiles
-      attr_reader :context
-
-      def initialize(context:)
-        @context = context
-      end
-
-      def set
+    class SetBundledFiles < Base
+      def perform
         # 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]

data/lib/rsgem/tasks/set_license_file.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module RSGem
+  module Tasks
+    class SetLicenseFile < Base
+      def perform
+        license.gsub!(
+          /.*Copyright.*/,
+          "Copyright (c) #{Date.today.year} Rootstrap"
+        )
+        write
+
+        puts "\tLICENSE file updated"
+      end
+
+      private
+
+      def license
+        @license ||= File.read(context.license_path)
+      end
+
+      def write
+        File.open(context.license_path, 'w') do |file|
+          file.puts license
+        end
+      end
+    end
+  end
+end

data/lib/rsgem/tasks/simple_cov_post_install.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RSGem
+  module Tasks
+    class SimpleCovPostInstall < Base
+      def perform
+        spec_helper.sub!("require \"#{gem_name}\"", <<~RUBY)
+          require 'simplecov'
+
+          SimpleCov.start do
+            add_filter '/spec/'
+          end
+
+          require '#{gem_name}'
+        RUBY
+
+        write
+      end
+
+      private
+
+      def gem_name
+        context.gem_name
+      end
+
+      def spec_helper
+        @spec_helper ||= File.read(context.spec_helper_path)
+      end
+
+      def write
+        File.open(context.spec_helper_path, 'w') do |file|
+          file.puts spec_helper
+        end
+      end
+    end
+  end
+end

data/lib/rsgem/version.rb

@@ -2,7 +2,7 @@
 
 module RSGem
   MAJOR = 0
-  MINOR = 1
+  MINOR = 3
   PATCH = 0
   VERSION = [MAJOR, MINOR, PATCH].join('.')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsgem
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Juan Manuel Ramallo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-14 00:00:00.000000000 Z
+date: 2020-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.80.0
+        version: 0.82.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.80.0
+        version: 0.82.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -116,6 +116,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - bin/console
@@ -145,11 +146,16 @@ files:
 - lib/rsgem/support/travis.yml
 - lib/rsgem/tasks/add_code_analysis.rb
 - lib/rsgem/tasks/add_dependency.rb
+- lib/rsgem/tasks/base.rb
+- lib/rsgem/tasks/bundle_dependencies.rb
 - lib/rsgem/tasks/clean_gemfile.rb
 - lib/rsgem/tasks/clean_gemspec.rb
+- lib/rsgem/tasks/create_gem.rb
 - lib/rsgem/tasks/ignore_gemfile_lock.rb
 - lib/rsgem/tasks/run_rubocop.rb
 - lib/rsgem/tasks/set_bundled_files.rb
+- lib/rsgem/tasks/set_license_file.rb
+- lib/rsgem/tasks/simple_cov_post_install.rb
 - lib/rsgem/version.rb
 homepage: https://github.com/rootstrap/rsgem
 licenses: