gemfile_locker 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2f411635748ebab869141b3e36ca6a8ef8cb7e5a
-  data.tar.gz: 8269cc977e333fe795775831873f7692184edb00
+SHA256:
+  metadata.gz: d2725a59f53ef8af74767a9452e43e17e5c1e402acfa78a97570698a40209c92
+  data.tar.gz: cfdf2128c68cde403638e976ca6a25454b342a2436134369a1c086c95eb893ce
 SHA512:
-  metadata.gz: 1845a4763600725c8f58d1f5e6c88579eb710a978e8553af9c9bcfcf27df0dbdd06a4b371cad3399c16a9a62aa284f4d05b7cebc63a213b1e119c4d8b526c639
-  data.tar.gz: 75009ff12e89fc6051e68af04d9fed9ade15a008170a636c58409c23f42214e1be13eae4d1feeed7878aaa0c2ab38d4424a7e9b1efd6a7c1dbe0a3687c723da6
+  metadata.gz: 78b6f30fb6d863984499c8f48de1d5f29070c35d861b1637cac54729d400ac0026392efe876ba0bb50dc070608a157e4cde6d301ec6cef3eee74146a0b1e01b8
+  data.tar.gz: 3e06350ba9b4be3c59f79b502399660b3c48147473f00f162183a91e10e67e409f7a13842db3e2cfcf8b4a82834972089581590f8be9d456df1c3deae3a456e5

data/gemfile_locker.gemspec

@@ -27,8 +27,9 @@ TXT
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'thor', '~> 0.19'
   spec.add_runtime_dependency 'bundler', '~> 1.13'
+  spec.add_runtime_dependency 'parser', '~> 2.0'
+  spec.add_runtime_dependency 'thor', '~> 0.19'
 
   spec.add_development_dependency 'rake', '~> 10.0'
 end

data/lib/gemfile_locker/gem_entry.rb

@@ -0,0 +1,54 @@
+module GemfileLocker
+  class GemEntry
+    attr_reader :rewriter, :node
+
+    def initialize(rewriter, node)
+      @rewriter = rewriter
+      @node = node
+    end
+
+    def name
+      node.children[2].children[0]
+    end
+
+    # Overriden in prepended modules.
+    def lock(**options)
+    end
+
+    # Overriden in prepended modules.
+    def unlock
+    end
+
+    require 'gemfile_locker/gem_entry/versions'
+    prepend Versions
+
+    require 'gemfile_locker/gem_entry/git_ref'
+    prepend GitRef
+
+    protected
+
+    # Node with gem options, if present.
+    def options_node
+      result = node.children.last
+      result if result.type == :hash
+    end
+
+    # Change content of string, keeping quoting style.
+    def replace_string_node(target, value)
+      quote = target.loc.begin.source
+      rewriter.replace(target.loc.expression, "#{quote}#{value}#{quote}")
+    end
+
+    # Remove node with preceding comma.
+    def remove_node_with_comma(target)
+      expression = target.loc.expression
+      comma_pos = expression.source_buffer.source.rindex(',', expression.begin_pos)
+      rewriter.remove(expression.with(begin_pos: comma_pos))
+    end
+
+    # Quote style used in name of gem.
+    def name_quote
+      node.children[2].loc.begin.source
+    end
+  end
+end

data/lib/gemfile_locker/gem_entry/git_ref.rb

@@ -0,0 +1,54 @@
+module GemfileLocker
+  class GemEntry
+    module GitRef
+      def lock(options)
+        git_ref = options[:git_ref]
+        set_git_ref(git_ref) if git_ref && !has_git_tag?
+        super
+      end
+
+      def unlock
+        remove_git_ref
+        super
+      end
+
+      def has_git_tag?
+        git_option_nodes.any? { |pair| pair.children[0].children[0] == :tag }
+      end
+
+      def set_git_ref(ref) # rubocop:disable AccessorMethodName
+        ref_node = ref_option_node
+        return replace_string_node(ref_node.children[1], ref) if ref_node
+        git_nodes = git_option_nodes
+        insert_after_node = git_nodes.any? ? git_nodes.last : node.children.last
+        quote = name_quote
+        rewriter.insert_after(insert_after_node.loc.expression.end, ", ref: #{quote}#{ref}#{quote}")
+      end
+
+      def remove_git_ref
+        ref_node = ref_option_node
+        remove_node_with_comma(ref_node) if ref_node
+      end
+
+      protected
+
+      def ref_option_node
+        return unless options_node
+        options_node.children.find do |pair|
+          pair.children[0].to_sexp_array == [:sym, :ref]
+        end
+      end
+
+      RELATED_OPTIONS = /\A(git*|branch|tag)\z/
+
+      def git_option_nodes
+        return [] unless options_node
+        options_node.children.reverse.select do |pair|
+          key_node = pair.children[0]
+          next unless key_node.type == :sym
+          RELATED_OPTIONS =~ key_node.children[0].to_s
+        end
+      end
+    end
+  end
+end

data/lib/gemfile_locker/gem_entry/versions.rb

@@ -0,0 +1,52 @@
+module GemfileLocker
+  class GemEntry
+    module Versions
+      EXTRA_VERSION_REGEXP = /\A[><]/
+
+      def lock(options)
+        version = options[:version]
+        set_version(version) if version
+        super
+      end
+
+      def unlock
+        remove_version
+        super
+      end
+
+      def locked?
+        version_nodes.any?
+      end
+
+      def set_version(version) # rubocop:disable AccessorMethodName
+        version_nodes = self.version_nodes
+        if version_nodes.any?
+          replace_string_node(version_nodes.first, version)
+        else
+          quote = name_quote
+          rewriter.insert_after(node.children[2].loc.end, ", #{quote}#{version}#{quote}")
+        end
+      end
+
+      def remove_version
+        # If multiple version strings are given, keep that which start with `>, >=, <, <=`.
+        version_nodes = self.version_nodes(strict: ->(versions) { versions.size > 1 })
+        version_nodes.each do |arg_node|
+          remove_node_with_comma(arg_node)
+        end
+      end
+
+      protected
+
+      def version_nodes(strict_if: nil, strict: !strict_if)
+        result = node.children.drop(3).select { |arg_node| arg_node.type == :str }
+        if strict_if && strict_if[result] || strict
+          result = result.reject do |arg_node|
+            EXTRA_VERSION_REGEXP =~ arg_node.children[0]
+          end
+        end
+        result
+      end
+    end
+  end
+end

data/lib/gemfile_locker/gemfile_processor.rb

@@ -1,27 +1,22 @@
+require 'parser'
+require 'parser/current'
+require 'gemfile_locker/gem_entry'
+
 module GemfileLocker
   class GemfileProcessor
-    GEM_LINE_REGEX = /
-      ^
-      (?<prefix>\s*gem\s*["'])
-      (?<name>[^'"]+)
-      (?<name_quote>['"])
-      (?<version_section>
-        (?<version_prefix>\s*,\s*['"])
-        (?<version>[^'"]*)
-        (?<version_quote>['"])
-      )?
-      (?<suffix>,?.*)?
-      $
-    /x
-    GEM_MATCH_FIELDS = %i(
-      prefix
-      name
-      name_quote
-      version_prefix
-      version
-      version_quote
-      suffix
-    ).freeze
+    class Rewriter < Parser::TreeRewriter
+      def rewrite(*args, &block)
+        @rewrite_block = block
+        super(*args)
+      end
+
+      def on_send(node)
+        children = node.children
+        return unless children[0].nil? && node.children[1] == :gem
+        gem_entry = GemEntry.new(self, node)
+        @rewrite_block[gem_entry]
+      end
+    end
 
     attr_reader :path, :options
 
@@ -30,47 +25,25 @@ module GemfileLocker
     end
 
     def call(string)
-      process_gems(string) do |data|
-        process_gem(data) unless skip_gem?(data)
+      buffer = Parser::Source::Buffer.new('(Gemfile)')
+      buffer.source = string
+      parser = Parser::CurrentRuby.new
+      ast = parser.parse(buffer)
+      Rewriter.new.rewrite(buffer, ast) do |gem_entry|
+        process_gem(gem_entry) unless skip_gem?(gem_entry)
       end
     end
 
-    def skip_gem?(data)
+    def skip_gem?(gem_entry)
       if options[:only]
-        !options[:only].include?(data[:name])
+        !options[:only].include?(gem_entry.name)
       elsif options[:except]
-        options[:except].include?(data[:name])
-      end
-    end
-
-    def process_gems(string)
-      string.gsub(GEM_LINE_REGEX) do
-        match = Regexp.last_match
-        data = Hash[GEM_MATCH_FIELDS.map { |x| [x, match[x]] }]
-        result = yield data
-        result ||= data
-        GEM_MATCH_FIELDS.map { |x| result[x] }.join
+        options[:except].include?(gem_entry.name)
       end
     end
 
     def process_gem(_name, _data)
       raise 'Abstract method'
     end
-
-    def set_gem_version(data, version)
-      data = data.dup
-      if version
-        data[:version_prefix] ||= ", #{data[:name_quote] || "'"}"
-        data[:version_quote] ||= data[:name_quote] || "'"
-        data[:version] = version
-      else
-        %i(
-          version_prefix
-          version
-          version_quote
-        ).each { |x| data.delete(x) }
-      end
-      data
-    end
   end
 end

data/lib/gemfile_locker/locker.rb

@@ -20,14 +20,15 @@ module GemfileLocker
       @bundler_specs ||= Bundler::LockfileParser.new(lockfile).specs
     end
 
-    def process_gem(data)
-      name = data[:name]
-      locked = bundler_specs.find { |x| x.name == name }
-      locked && set_gem_version(data, prepare_version(locked.version))
+    def process_gem(gem_entry)
+      name = gem_entry.name
+      spec = bundler_specs.find { |x| x.name == name }
+      return unless spec
+      gem_entry.lock(version: prepare_version(spec.version), git_ref: prepare_git_ref(spec))
     end
 
-    def skip_gem?(data)
-      super || data[:version] && !options[:force]
+    def skip_gem?(gem_entry)
+      super || gem_entry.locked? && !options[:force]
     end
 
     private
@@ -40,5 +41,11 @@ module GemfileLocker
         version.to_s
       end
     end
+
+    def prepare_git_ref(spec)
+      if spec.source.is_a?(Bundler::Source::Git)
+        spec.source.options['ref'] || spec.source.revision[0...7]
+      end
+    end
   end
 end

data/lib/gemfile_locker/unlocker.rb

@@ -2,8 +2,8 @@ module GemfileLocker
   class Unlocker < GemfileProcessor
     attr_reader :lockfile
 
-    def process_gem(data)
-      set_gem_version(data, nil)
+    def process_gem(gem_entry)
+      gem_entry.unlock
     end
   end
 end

data/lib/gemfile_locker/version.rb

@@ -1,5 +1,5 @@
 module GemfileLocker
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 
   def self.gem_version
     Gem::Version.new VERSION

metadata

@@ -1,43 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: gemfile_locker
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Max Melentiev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-19 00:00:00.000000000 Z
+date: 2018-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '1.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '1.13'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -81,6 +95,9 @@ files:
 - lib/gemfile_locker.rb
 - lib/gemfile_locker/cli.rb
 - lib/gemfile_locker/file_editor.rb
+- lib/gemfile_locker/gem_entry.rb
+- lib/gemfile_locker/gem_entry/git_ref.rb
+- lib/gemfile_locker/gem_entry/versions.rb
 - lib/gemfile_locker/gemfile_processor.rb
 - lib/gemfile_locker/locker.rb
 - lib/gemfile_locker/unlocker.rb
@@ -104,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Tool to manage Gemfile. Lock and unlock all dependencies for safe `bundle