eac_ruby_gems_utils 0.5.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03ed15ab71663ad44165776c7ad4b0993af1a11b1886cb02118a46d31339f503
-  data.tar.gz: fe497eb1240ae1190394dab833df4814965fe852ce3df4c451edf570c9a7a912
+  metadata.gz: 6e22689b28c655a76ab05c049502d3723179ab7478a3ed29ddca72d2d025a428
+  data.tar.gz: b729e4e446f6f6d8da520625d5d3451287180ebe703930518733310a508d0995
 SHA512:
-  metadata.gz: a7382fe287f7caeebeb731f0f33085aedaaa97185352088bb68e32fe7ac0443df1810e60562e9be16ebdcb9cfa982e2747654cf6a3ca191862784645dc0699de
-  data.tar.gz: e3fa0d3c3533ef63aaa396d54b40e958c69e6a472c903811d7c7e89c33f565e787cfb75bca150542a268497c31739252f74eed53dd7295d2d519f0adbd474b0b
+  metadata.gz: 56718b85ff502646e0b548103d5d6c9d423e15641c033ddc62cab5534ae0b52c0591b600fb79107c99126fb6e5a5e84c59816fa7e188961881bb811ac8d41873
+  data.tar.gz: 2e8eecf1678a665fa9cd2dd248eced1561130cb85f3dfd8d01e4ac445f68d0f21f7309b1a0ab2cf05bf34f7e5cea7e69cfc3bd00b137af7942e0d9f9c560935e

data/.gitignore

@@ -0,0 +1,3 @@
+/Gemfile.lock
+doc/**/*
+.yardoc/**/*

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,25 @@
+require:
+  - rubocop-rails
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.4
+
+Layout/LineLength:
+  Max: 100
+
+Rails/RakeEnvironment:
+  Exclude:
+    - spec/support/mygem/Rakefile
+
+Style/Documentation:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/LICENCE

@@ -0,0 +1,16 @@
+Copyright (c) 2020 Eduardo Henrique Bogoni
+
+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 (including the next paragraph) 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/eac_ruby_gems_utils.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+
+# Maintain your gem's version:
+require 'eac_ruby_gems_utils/version'
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = 'eac_ruby_gems_utils'
+  s.version     = ::EacRubyGemsUtils::VERSION
+  s.authors     = ['Esquilo Azul Company']
+  s.summary     = 'Utilities for Ruby gems development.'
+  s.license     = 'MIT'
+  s.homepage    = 'https://github.com/esquilo-azul/eac_ruby_gems_utils'
+  s.metadata    = { 'source_code_uri' => s.homepage }
+
+  s.extra_rdoc_files = ['README.rdoc']
+  s.rdoc_options = ['--charset=UTF-8']
+
+  s.require_paths = ['lib']
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files spec examples`.split("\n")
+
+  s.add_dependency 'eac_ruby_utils', '~> 0.29'
+
+  # Tests
+  s.add_development_dependency 'eac_ruby_gem_support', '~> 0.1'
+end

data/lib/eac_ruby_gems_utils/gem.rb

@@ -2,6 +2,7 @@
 
 require 'eac_ruby_utils/core_ext'
 require 'eac_ruby_utils/envs'
+require 'rubygems'
 
 module EacRubyGemsUtils
   class Gem
@@ -22,6 +23,11 @@ module EacRubyGemsUtils
       ::EacRubyGemsUtils::Gem::Command.new(self, %w[bundle] + args).envvar_gemfile
     end
 
+    # @return A [Pathname] array with relative paths from root listed in gemspec's .file directive.
+    def files
+      gemspec.files.map(&:to_pathname)
+    end
+
     def gemfile_lock_gem_version(gem_name)
       gemfile_lock_content.specs.find { |gem| gem.name == gem_name }.if_present(&:version)
     end
@@ -39,7 +45,12 @@ module EacRubyGemsUtils
     end
 
     def name_by_path
-      root.basename.to_s
+      fullname = root.basename.to_s
+      /\A(.+)(?:-\d+(?:\.\d+)*)\z/.if_match(fullname, false) { |m| m[1] }.if_present(fullname)
+    end
+
+    def namespace_parts
+      name.split('-')
     end
 
     def rake(*args)
@@ -48,6 +59,10 @@ module EacRubyGemsUtils
       bundle('exec', 'rake', '--rakefile', rakefile_path, *args)
     end
 
+    def version
+      version_file.value
+    end
+
     private
 
     def gemfile_path_uncached
@@ -55,7 +70,11 @@ module EacRubyGemsUtils
     end
 
     def gemfile_lock_path_uncached
-      root.join('Gemfile.lock')
+      gemfile_path.basename_sub { |b| "#{b}.lock" }
+    end
+
+    def gemspec_uncached
+      ::Gem::Specification.load(gemspec_path.to_path)
     end
 
     def gemspec_path_uncached
@@ -65,5 +84,13 @@ module EacRubyGemsUtils
     def rakefile_path_uncached
       root.join('Rakefile')
     end
+
+    def version_file_uncached
+      ::EacRubyGemsUtils::Gem::VersionFile.new(version_file_path)
+    end
+
+    def version_file_path_uncached
+      root.join('lib', *namespace_parts, 'version.rb')
+    end
   end
 end

data/lib/eac_ruby_gems_utils/gem/version_file.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacRubyGemsUtils
+  class Gem
+    class VersionFile
+      common_constructor :path
+
+      VERSION_LINE_PATTERN = /\A(\s*)VERSION\s*=\s*[\'\"]([^\'\"]+)[\'\"](\s*)\z/.freeze
+
+      def value
+        path.read.each_line do |line|
+          VERSION_LINE_PATTERN.if_match(line.rstrip, false) do |m|
+            ::Gem::Version.new(m[2])
+          end
+        end
+      end
+
+      def value=(new_value)
+        path.write(new_value_content(new_value))
+      end
+
+      private
+
+      def new_value_content(new_value)
+        path.read.each_line
+            .map { |line| new_value_line(line, new_value) }
+            .join
+      end
+
+      def new_value_line(line, new_value)
+        m = VERSION_LINE_PATTERN.match(line)
+        return line unless m
+
+        "#{m[1]}VERSION = '#{new_value}'#{m[3]}"
+      end
+    end
+  end
+end

data/lib/eac_ruby_gems_utils/tests/multiple.rb

@@ -7,6 +7,7 @@ require 'eac_ruby_utils/core_ext'
 module EacRubyGemsUtils
   module Tests
     class Multiple
+      require_sub __FILE__
       enable_console_speaker
       enable_simple_cache
       common_constructor :gems, :options, default: [{}]
@@ -26,14 +27,9 @@ module EacRubyGemsUtils
         decorated_gems.flat_map(&:tests)
       end
 
-      def bundle_all_gems
-        infom 'Bundling all gems...'
-        decorated_gems.each do |gem|
-          next unless gem.gemfile_path.exist?
-
-          infov 'Bundle install', gem
-          gem.bundle.execute!
-        end
+      def prepare_all_gems
+        infom 'Preparing all gems...'
+        decorated_gems.each(&:prepare)
       end
 
       def decorated_gems_uncached
@@ -61,7 +57,7 @@ module EacRubyGemsUtils
 
       def run
         start_banner
-        bundle_all_gems
+        prepare_all_gems
         test_all_gems
         final_results_banner
       end
@@ -76,31 +72,6 @@ module EacRubyGemsUtils
           infov test, Result.new(test.result).tag
         end
       end
-
-      class DecoratedGem < ::SimpleDelegator
-        def tests
-          [::EacRubyGemsUtils::Tests::Minitest.new(__getobj__),
-           ::EacRubyGemsUtils::Tests::Rspec.new(__getobj__)]
-        end
-      end
-
-      class Result
-        common_constructor :result
-
-        COLORS = {
-          ::EacRubyGemsUtils::Tests::Base::RESULT_FAILED => :red,
-          ::EacRubyGemsUtils::Tests::Base::RESULT_NONEXISTENT => :white,
-          ::EacRubyGemsUtils::Tests::Base::RESULT_SUCCESSFUL => :green
-        }.freeze
-
-        def tag
-          result.to_s.send(color)
-        end
-
-        def color
-          COLORS.fetch(result)
-        end
-      end
     end
   end
 end

data/lib/eac_ruby_gems_utils/tests/multiple/decorated_gem.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module EacRubyGemsUtils
+  module Tests
+    class Multiple
+      class DecoratedGem < ::SimpleDelegator
+        enable_console_speaker
+
+        def prepare
+          return unless gemfile_path.exist?
+
+          log('running "bundle install"...')
+          return if bundle('install').execute.fetch(:exit_code).zero?
+
+          if can_remove_gemfile_lock?
+            log('"bundle install" failed, removing Gemfile.lock and trying again...')
+            gemfile_lock_path.unlink if gemfile_lock_path.exist?
+            bundle('install').execute!
+          else
+            raise '"bundle install" failed and the Gemfile.lock is part of gem' \
+              '(Should be changed by developer)'
+          end
+        end
+
+        def tests
+          [::EacRubyGemsUtils::Tests::Minitest.new(__getobj__),
+           ::EacRubyGemsUtils::Tests::Rspec.new(__getobj__)]
+        end
+
+        private
+
+        def log(message)
+          infov self, message
+        end
+
+        def can_remove_gemfile_lock?
+          !files.include?(gemfile_lock_path.relative_path_from(root))
+        end
+      end
+    end
+  end
+end

data/lib/eac_ruby_gems_utils/tests/multiple/result.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module EacRubyGemsUtils
+  module Tests
+    class Multiple
+      class Result
+        common_constructor :result
+
+        COLORS = {
+          ::EacRubyGemsUtils::Tests::Base::RESULT_FAILED => :red,
+          ::EacRubyGemsUtils::Tests::Base::RESULT_NONEXISTENT => :white,
+          ::EacRubyGemsUtils::Tests::Base::RESULT_SUCCESSFUL => :green
+        }.freeze
+
+        def tag
+          result.to_s.send(color)
+        end
+
+        def color
+          COLORS.fetch(result)
+        end
+      end
+    end
+  end
+end

data/lib/eac_ruby_gems_utils/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EacRubyGemsUtils
-  VERSION = '0.5.0'
+  VERSION = '0.7.1'
 end

data/spec/lib/eac_ruby_gems_utils/gem_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_gems_utils/gem'
+
+::RSpec.describe ::EacRubyGemsUtils::Gem do
+  let(:mygem_path) { ::Pathname.new(__dir__).expand_path.parent.parent.join('support', 'mygem') }
+  let(:mygem) { described_class.new(mygem_path) }
+
+  describe '#bundle' do
+    specify do
+      expect(mygem.bundle('exec', 'myrunner').execute!).to include('My Runner')
+    end
+  end
+
+  describe '#rake' do
+    specify do
+      expect(mygem.rake('mygem:stub').execute!).to include('Stub!')
+    end
+  end
+end

data/spec/rubocop_check_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_gem_support/spec/examples/rubocop_check'
+
+RSpec.describe ::RuboCop do
+  include_examples 'rubocop_check', ::File.expand_path('../..', __dir__)
+end

data/spec/spec_helper.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  #   # This allows you to limit a spec run to individual examples or groups
+  #   # you care about by tagging them with `:focus` metadata. When nothing
+  #   # is tagged with `:focus`, all examples get run. RSpec also provides
+  #   # aliases for `it`, `describe`, and `context` that include `:focus`
+  #   # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  #   config.filter_run_when_matching :focus
+  #
+  #   # Allows RSpec to persist some state between runs in order to support
+  #   # the `--only-failures` and `--next-failure` CLI options. We recommend
+  #   # you configure your source control system to ignore this file.
+  #   config.example_status_persistence_file_path = "spec/examples.txt"
+  #
+  #   # Limits the available syntax to the non-monkey patched syntax that is
+  #   # recommended. For more details, see:
+  #   #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  #   config.disable_monkey_patching!
+  #
+  #   # This setting enables warnings. It's recommended, but in some cases may
+  #   # be too noisy due to issues in dependencies.
+  #   config.warnings = true
+  #
+  #   # Many RSpec users commonly either run the entire suite or an individual
+  #   # file, and it's useful to allow more verbose output when running an
+  #   # individual spec file.
+  #   if config.files_to_run.one?
+  #     # Use the documentation formatter for detailed output,
+  #     # unless a formatter has already been configured
+  #     # (e.g. via a command-line flag).
+  #     config.default_formatter = "doc"
+  #   end
+  #
+  #   # Print the 10 slowest examples and example groups at the
+  #   # end of the spec run, to help surface which specs are running
+  #   # particularly slow.
+  #   config.profile_examples = 10
+  #
+  #   # Run specs in random order to surface order dependencies. If you find an
+  #   # order dependency and want to debug it, you can fix the order by providing
+  #   # the seed, which is printed after each run.
+  #   #     --seed 1234
+  #   config.order = :random
+  #
+  #   # Seed global randomization in this process using the `--seed` CLI option.
+  #   # Setting this allows you to use `--seed` to deterministically reproduce
+  #   # test failures related to randomization by passing the same `--seed` value
+  #   # as the one that triggered the failure.
+  #   Kernel.srand config.seed
+end

data/spec/support/mygem/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/spec/support/mygem/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: .
+  specs:
+    mygem (1.0.0)
+      rake
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (13.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mygem!
+
+BUNDLED WITH
+   1.17.3

data/spec/support/mygem/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+namespace :mygem do
+  desc 'A stub task.'
+  task :stub do
+    puts 'Stub!'
+  end
+end

data/spec/support/mygem/exe/myrunner

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+puts 'My Runner'

data/spec/support/mygem/lib/mygem.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Mygem
+  require 'mygem/version'
+end

data/spec/support/mygem/lib/mygem/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Mygem
+  VERSION = '1.0.0'
+end

data/spec/support/mygem/mygem.gemspec

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+
+Gem::Specification.new do |s|
+  s.name        = 'mygem'
+  s.version     = '1.0.0'
+  s.authors     = ['Esquilo Azul Company']
+  s.summary     = 'Stub gem.'
+
+  s.files = Dir['{exe,lib}/**/*', 'Gemfile', 'Rakefile']
+  s.bindir = 'exe'
+  s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+
+  s.add_dependency 'rake'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eac_ruby_gems_utils
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Esquilo Azul Company
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-14 00:00:00.000000000 Z
+date: 2020-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eac_ruby_utils
@@ -42,24 +42,46 @@ description:
 email: 
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.rdoc
 files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENCE
 - README.rdoc
+- eac_ruby_gems_utils.gemspec
 - lib/eac_ruby_gems_utils.rb
 - lib/eac_ruby_gems_utils/gem.rb
 - lib/eac_ruby_gems_utils/gem/command.rb
+- lib/eac_ruby_gems_utils/gem/version_file.rb
 - lib/eac_ruby_gems_utils/tests.rb
 - lib/eac_ruby_gems_utils/tests/base.rb
 - lib/eac_ruby_gems_utils/tests/minitest.rb
 - lib/eac_ruby_gems_utils/tests/multiple.rb
+- lib/eac_ruby_gems_utils/tests/multiple/decorated_gem.rb
+- lib/eac_ruby_gems_utils/tests/multiple/result.rb
 - lib/eac_ruby_gems_utils/tests/rspec.rb
 - lib/eac_ruby_gems_utils/version.rb
-homepage: 
+- spec/lib/eac_ruby_gems_utils/gem_spec.rb
+- spec/rubocop_check_spec.rb
+- spec/spec_helper.rb
+- spec/support/mygem/Gemfile
+- spec/support/mygem/Gemfile.lock
+- spec/support/mygem/Rakefile
+- spec/support/mygem/exe/myrunner
+- spec/support/mygem/lib/mygem.rb
+- spec/support/mygem/lib/mygem/version.rb
+- spec/support/mygem/mygem.gemspec
+homepage: https://github.com/esquilo-azul/eac_ruby_gems_utils
 licenses:
-- GPL3
-metadata: {}
+- MIT
+metadata:
+  source_code_uri: https://github.com/esquilo-azul/eac_ruby_gems_utils
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- "--charset=UTF-8"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -73,9 +95,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Utilities for Ruby gems development.
-test_files: []
+test_files:
+- spec/lib/eac_ruby_gems_utils/gem_spec.rb
+- spec/rubocop_check_spec.rb
+- spec/spec_helper.rb
+- spec/support/mygem/Gemfile
+- spec/support/mygem/Gemfile.lock
+- spec/support/mygem/Rakefile
+- spec/support/mygem/exe/myrunner
+- spec/support/mygem/lib/mygem.rb
+- spec/support/mygem/lib/mygem/version.rb
+- spec/support/mygem/mygem.gemspec