pessimize 0.2.0 → 0.3.0

data/CHANGELOG

@@ -1,3 +1,14 @@
+=== Pessimize 0.3.0
+
+Features:
+ * Increased compatibility with Gemfile syntax, which should support
+ practically all Gemfiles.
+ * Some minor refactoring for clarity (ongoing, as always)
+
+Bug fixes:
+ * Fix issue with certain valid ruby expressions not being parsed correctly,
+ e.g. new lines in "gem" definitions
+
 === Pessimize 0.2.0
 
 Features:

data/Gemfile

@@ -1,3 +1,2 @@
 source "https://rubygems.org"
 gemspec 
-

data/README.md

@@ -2,6 +2,8 @@
 
 [![Gem Version](https://badge.fury.io/rb/pessimize.png)](http://badge.fury.io/rb/pessimize)
 [![Build Status](https://travis-ci.org/joonty/pessimize.png?branch=master)](https://travis-ci.org/joonty/pessimize)
+[![Code Climate](https://codeclimate.com/github/joonty/pessimize/badges/gpa.svg)](https://codeclimate.com/github/joonty/pessimize)
+[![Test Coverage](https://codeclimate.com/github/joonty/pessimize/badges/coverage.svg)](https://codeclimate.com/github/joonty/pessimize/coverage)
 
 ### Who is this for?
 Anyone who works with a Gemfile, i.e. a project that uses [bundler][1].
@@ -65,9 +67,7 @@ Also, by default, the Gemfile and Gemfile.lock are copied as a form of backup. T
 
 ## Known issues
 
-Pessimize parses the Gemfile as tokens, and does some tricky stuff to replace or insert version numbers. However, this is fairly experimental and there are plans to use a proper ruby parser, which should be more reliable and cut out the edge cases. It *should* currently work for the majority of cases, but there are no guarantees.
-
-[See this issue][3] for tracking the progress.
+Recent issues with certain Gemfile syntax edge cases have been fixed, so there are currently no known issues. If you do find pessimize doing something strange, or not correctly picking up information in your Gemfile, it would be greatly appreciated if you submit an issue.
 
 ## Why `bundle update` can be dangerous
 

data/lib/pessimize/gem.rb

@@ -49,7 +49,7 @@ module Pessimize
       token_before_version = original_tokens.index { |t| t[1] == :on_comma }
       if token_before_version
         remaining_tokens = original_tokens[(token_before_version + 1)..-1]
-        while [:on_sp, :on_tstring_beg].include? remaining_tokens.first[1]
+        while [:on_sp, :on_tstring_beg, :on_ignored_nl].include? remaining_tokens.first[1]
           remaining_tokens.shift
           token_before_version += 1
         end

data/lib/pessimize/gemfile.rb

@@ -3,33 +3,25 @@ require 'pessimize/gem'
 
 module Pessimize
   class Gemfile
-    attr_reader :tokens, :gems
+    attr_reader :gems
 
     def initialize(contents)
-      self.tokens = Ripper.lex(contents)
-      self.gems = []
+      self.tokens        = Ripper.lex(contents)
+      self.gems          = []
       self.gem_token_map = []
-      parse_tokens!
+
+      parse_gems_from_tokens!
     end
 
     def to_s
-      compiled_tokens = tokens.dup
-      current_offset = 0
-      gem_token_map.zip(gems).each do |(tok_start, tok_end), gem|
-        gem_tokens = gem.tokens
-        compiled_tokens[(current_offset + tok_start)..(current_offset + tok_end)] = gem_tokens
-        current_offset += gem_tokens.length - (tok_end - tok_start + 1)
-      end
-      compiled_tokens.inject("") { |a, e|
-        a + e[2]
-      }
+      TokenCompiler.new(tokens).compile_to_string(gems, gem_token_map)
     end
 
   protected
-    attr_writer :gems, :tokens
-    attr_accessor :gem_token_map
+    attr_writer :gems
+    attr_accessor :gem_token_map, :tokens
 
-    def parse_tokens!
+    def parse_gems_from_tokens!
       enum = tokens.each_with_index
 
       loop do
@@ -37,7 +29,7 @@ module Pessimize
 
         if tok[1] == :on_ident && tok[2] == "gem"
           gem_toks = []
-          until [:on_nl].include?(enum.peek[0][1])
+          until all_gem_tokens_collected?(tok[0], enum.peek[0])
             (tok, j) = enum.next
             gem_toks << tok
           end
@@ -48,5 +40,34 @@ module Pessimize
       end
     rescue StopIteration
     end
+
+    def all_gem_tokens_collected?(current_token, next_token)
+      next_token[1] == :on_nl
+    end
+
+    class TokenCompiler
+      def initialize(tokens)
+        self.tokens = tokens.dup
+        self.offset = 0
+      end
+
+      def compile_to_string(gems, gem_token_map)
+        gem_token_map.zip(gems).each do |(token_start, token_end), gem|
+          insert_gem_into_tokens! gem, token_start, token_end
+        end
+
+        tokens.reduce("") { |a, e|
+          a + e[2]
+        }
+      end
+
+    protected
+      attr_accessor :tokens, :offset
+
+      def insert_gem_into_tokens!(gem, token_start, token_end)
+        self.tokens[(offset + token_start)..(offset + token_end)] = gem.tokens
+        self.offset += gem.tokens.length - (token_end - token_start + 1)
+      end
+    end
   end
 end

data/lib/pessimize/version.rb

@@ -1,3 +1,3 @@
 module Pessimize
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/pessimize.gemspec

@@ -18,6 +18,7 @@ This is for people who work with projects that use bundler, such as rails projec
   gem.add_dependency 'trollop'
   gem.add_development_dependency 'rspec', '~> 2.13.0'
   gem.add_development_dependency 'rake', '~> 10.0.3'
+  gem.add_development_dependency "codeclimate-test-reporter"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/spec/gem_spec.rb

@@ -70,5 +70,29 @@ module Pessimize
       end
 
     end
+
+    context "creating a gem using new lines for arguments" do
+      let(:gem_string) { <<GEM.strip
+gem "blah",
+  "2.0.0beta",
+  group: :development
+GEM
+      }
+
+      let(:gem) { Gem.new(Ripper.lex(gem_string)) }
+      subject { gem }
+
+      its(:name) { should == "blah" }
+      its(:version) { should == "2.0.0beta" }
+
+      context "after setting the version" do
+        before do
+          gem.version = "~> 2.1"
+        end
+
+        its(:to_s) { should == %Q(gem "blah",\n  "~> 2.1",\n  group: :development) }
+      end
+
+    end
   end
 end

data/spec/gemfile_spec.rb

@@ -118,5 +118,73 @@ GEM
         its(:to_s) { should == expected_defn }
       end
     end
+
+    context "with multiple gem definitions spanning multiple lines" do
+
+      let(:gem_defn) { <<-GEM
+source "https://rubygems.org"
+
+gem "monkey",
+  "2.0.0"
+
+gem "thor",
+  ">= 1.3.0"
+GEM
+      }
+
+      subject(:gemfile) { Gemfile.new(gem_defn) }
+
+      its(:to_s) { should == gem_defn }
+
+      describe "#gems" do
+        subject(:gems) { gemfile.gems }
+
+        its(:length) { should == 2 }
+
+        describe "the first gem" do
+          subject(:gem) { gems[0] }
+
+          its(:name) { should == "monkey" }
+          its(:version) { should == "2.0.0" }
+          its(:to_s) { should == %Q( "monkey",\n  "2.0.0") }
+
+          context "setting the version" do
+            before do
+              gem.version = "~> 2.0.0"
+            end
+
+            its(:to_s) { should == %Q( "monkey",\n  "~> 2.0.0") }
+          end
+        end
+
+        describe "the second gem" do
+          subject { gems[1] }
+
+          its(:name) { should == "thor" }
+          its(:version) { should == ">= 1.3.0" }
+        end
+      end
+
+      context "after setting the gem versions" do
+        before do
+          gemfile.gems.each do |gem|
+            gem.version = "~> 1.0.0"
+          end
+        end
+
+        let(:expected_defn) { <<-GEM
+source "https://rubygems.org"
+
+gem "monkey",
+  "~> 1.0.0"
+
+gem "thor",
+  "~> 1.0.0"
+GEM
+        }
+
+        its(:to_s) { should == expected_defn }
+      end
+    end
   end
 end

data/spec/integration_spec.rb

@@ -538,4 +538,53 @@ end
 
     it_behaves_like "a working pessimizer without backups", gemfile, lockfile, result, '--no-backup'
   end
+
+  context "with a Gemfile using new lines for gem definitions" do
+    gemfile = <<-EOD
+source "https://rubygems.org"
+gem 'json',
+  group: :production
+
+gem 'pessimize',
+  github: "joonty/pessimize"
+
+group :development, :test do
+  gem 'sqlite3',
+    '>= 1.3.7'
+end
+    EOD
+
+    lockfile = <<-EOD
+GIT
+  remote: git://github.com/joonty/pessimize.git
+  revision: 40f6ec6c7483a453b72e09efbba0e0d7de3b37ab
+  specs:
+    pessimize (0.2.0)
+      bundler
+      trollop
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    json (1.8.0)
+    trollop (2.1.2)
+    sqlite3 (1.3.7)
+    EOD
+
+    result = <<-EOD
+source "https://rubygems.org"
+gem 'json', "~> 1.8",
+  group: :production
+
+gem 'pessimize',
+  github: "joonty/pessimize"
+
+group :development, :test do
+  gem 'sqlite3',
+    '~> 1.3'
+end
+    EOD
+
+    it_behaves_like "a working pessimizer", gemfile, lockfile, result
+  end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
 require 'rspec'
 require 'pessimize'
 require 'open3'

metadata

@@ -1,71 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: pessimize
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jon Cairns
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-29 00:00:00.000000000 Z
+date: 2015-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: trollop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: trollop
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.13.0
+  type: :development
   prerelease: false
-  type: :runtime
-- !ruby/object:Gem::Dependency
-  name: rspec
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.13.0
-  prerelease: false
+        version: 10.0.3
   type: :development
-- !ruby/object:Gem::Dependency
-  name: rake
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 10.0.3
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 10.0.3
-  prerelease: false
+        version: '0'
   type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |-
   Add the pessimistic constraint operator to all gems in your Gemfile, restricting the maximum update version.
 
@@ -77,8 +91,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
 - CHANGELOG
 - Gemfile
 - LICENSE.txt
@@ -107,26 +123,27 @@ homepage: https://github.com/joonty/pessimize
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+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: []
-rubyforge_project:
-rubygems_version: 2.4.6
-signing_key:
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
 specification_version: 4
-summary: Add the pessimistic constraint operator to all gems in your Gemfile, restricting the maximum update version.
+summary: Add the pessimistic constraint operator to all gems in your Gemfile, restricting
+  the maximum update version.
 test_files:
 - spec/data/Gemfile.lock.example
 - spec/data/Gemfile.lock.example2