rocktumbler 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bce5c9401a68c7e3affab0ede028d49a9fa1788c
-  data.tar.gz: f147131378af6aa520cde277116630d7a165966f
+  metadata.gz: 3672a2966e07f824bf93a4fa47783b2a7e6f9db8
+  data.tar.gz: e465ca4f509cc7e1c3cd7440864869e11c6c6243
 SHA512:
-  metadata.gz: 0dd510df2f24c90f76e5a611936cd4b2aef5df418ee7987144d7fec607bae01b7213f2db454abb8449c2740139420ef6f59b9ee7c0638de9c4e6f1155916dd53
-  data.tar.gz: 05ea6eec53ec5301afc4f74a4ceefb423642a8267781ed810546425141bcf7f0b8886a1cf9a30ae9b2ee58002a1b3bb53ac50a0cb96cd941cf8f300b60e3a8ab
+  metadata.gz: 14d46c2c1a4a47cea7313a327a4dcbfe1823560922b6d87871cba6d7fe534a794038e9775752e941c3886f3e70aa2c27f446d9c1434a3d340e0ab11d677182eb
+  data.tar.gz: 9d8850f4559bff799ec5e35afe9e3167fdb041d418bb0d283c539361e3663e8249677e44c9d7c7120e450b3df91a5c65040beb23b1ab44749a2223c03c478bac

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem

data/.travis.yml

@@ -1,3 +1,5 @@
-language: ruby
 rvm:
-  - 2.1.4
+  - 2.2
+  - 2.1
+  - 2.0.0
+  - 1.9.3

data/README.md

@@ -1,6 +1,45 @@
 # Rocktumbler
 
-Rocktumbler is a gem that will take your existing Gemfile and rewrite it to ensure that it remains formatted and consistent.
+[![Build Status](https://travis-ci.org/simonreed/rocktumbler.svg)](https://travis-ci.org/simonreed/rocktumbler)
+
+Rocktumbler is a gem that will take your existing Gemfile and ensure that it remains formatted and consistent.
+
+It enforces a style to your Gemfile to make it easy to read and understand your Gemfile. Including :
+
+* Single quotes.
+* Ruby 1.9 hash syntax.
+* 2 Space Indentation.
+* Sort gems alphabetically.
+* Organise groups around the block form.
+* Add Gem description and url, making it easier to document what a gem is used for (optional).
+
+It will produce a Gemfile that is compliant with the default config for Rubocop.
+
+## Example
+
+Before
+
+```ruby
+source "https://rubygems.org"
+  gem 'pg'
+gem "rocktumbler"
+gem 'pry', :require => 'pry', :group => 'development'
+gem 'rubocop',                 group: 'development'
+```
+
+After
+
+```ruby
+source 'https://rubygems.org'
+
+gem 'pg'
+gem 'rocktumbler'
+
+group :development do
+  gem 'pry', require: 'pry'
+  gem 'rubocop'
+end
+```
 
 ## Installation
 
@@ -14,7 +53,54 @@ And then execute:
 
     $ tumble
 
-This will then rewrite your Gemfile making sure that you use single quotes and gives a brief description of what each gem does.
+This will then rewrite your Gemfile giving you a fresh, clean and consistent Gemfile.
+
+## CLI Options
+
+```
+Usage: tumble [options]
+
+Specific options:
+    -i, --info                       Display gem info comment.
+    -d, --homepage                   Display gem homepage comment.
+    -s, --skip-write                 Skip writing of Gemfile
+
+Common options:
+    -h, --help                       Show this message
+        --version                    Show version
+```
+
+### Gem Info Comments
+
+If you wish to display Gem info within your Gemfile to aid readablility you can specify the `-i` or `--info` option on the CLI. The gem homepage url can be added with the `-d` or `--homepage` option.
+
+`tumble --info --homepage`
+
+will give you :
+
+```ruby
+source 'https://rubygems.org'
+
+# Pg is the Ruby interface to the {PostgreSQL RDBMS}[http://www.postgresql.org/]
+# https://bitbucket.org/ged/ruby-pg
+gem 'pg'
+# Polish your Gemfile to make sure it remains consistent.
+# https://github.com/simonreed/rocktumbler
+gem 'rocktumbler'
+
+group :development do
+  # An IRB alternative and runtime developer console
+  # http://pryrepl.org
+  gem 'pry', require: 'pry'
+  # Automatic Ruby code style checking tool.
+  # http://github.com/bbatsov/rubocop
+  gem 'rubocop'
+end
+```
+
+## Bundler integration
+
+All generated Gemfiles are parsed and verified against the original Gemfile using Bundler to ensure the Bundler configuration remains unchanged. No need to worry about Gems going missing.
 
 ## Development
 
@@ -22,7 +108,7 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-TODO: Add tests!
+TODO: Add more test coverage!
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,12 @@
-require "bundler/gem_tasks"
+# encoding: utf-8
 
+require 'rubygems'
+require 'bundler'
+require 'bundler/gem_tasks'
+
+require 'rake'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:spec]

data/bin/tumble

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 # Exit cleanly from an early interrupt
-Signal.trap("INT") { exit 1 }
+Signal.trap('INT') { exit 1 }
 
 require 'rocktumbler'
 Rocktumbler::Tumbler.new.tumble

data/lib/rocktumbler/gem.rb

@@ -1,28 +1,48 @@
 require_relative 'exceptions'
 
 module Rocktumbler
+  # The Gem is a class responsible for handling outputting info on a Rubygem
   class Gem
-    def initialize(gem_dependency)
-      @gem_dependency = gem_dependency
+    def initialize(gem_dep, opts)
+      @gem_dep = gem_dep
+      @opts = opts
     end
 
-    def print(prepend="")
-      gem_info = retrieve_gem_information(@gem_dependency.name)
-      str = "#{prepend}# #{gem_info.summary}\n"
-      str += "#{prepend}# #{gem_info.homepage}\n"
-      str += "#{prepend}gem '#{@gem_dependency.name}'"
-      str += ",'#{@gem_dependency.requirement}'" unless @gem_dependency.requirement.none?
-      str += generate_gem_source(@gem_dependency.source.options) if @gem_dependency.source
-      str += generate_require(@gem_dependency.autorequire) if @gem_dependency.autorequire
-      str += "\n\n"
+    def print(prepend = '')
+      max_length = 80 - 2 - prepend.chars.count
+      gem_info = retrieve_gem_information(@gem_dep.name, max_length)
+      formatted_line(prepend, gem_info)
     end
 
     private
 
-    def generate_require(autorequire)
+    def formatted_line(prepend, gem_info)
+      if @opts.gem_info
+        str = "#{prepend}# #{gem_info.summary.strip}\n"
+      else
+        str = ''
+      end
+      str += format_homepage(gem_info.homepage, prepend) if @opts.gem_homepage
+      str += "#{prepend}gem '#{@gem_dep.name}'"
+      str += format_requirement || ''
+      str += format_source
+      str += format_require(@gem_dep.autorequire)
+      str
+    end
+
+    def format_requirement
+      ", '#{@gem_dep.requirement}'" unless @gem_dep.requirement.none?
+    end
+
+    def format_homepage(homepage, prepend)
+      (homepage.nil?) ? "#{prepend}#\n" : "#{prepend}# #{homepage}\n"
+    end
+
+    def format_require(autorequire)
+      return '' unless autorequire
       if autorequire.count > 1
         # Array.to_s will output double quotes so we gsub them to singles.
-        return ", require: #{autorequire.to_s.gsub(/"/,'\'')}"
+        return ", require: #{autorequire.to_s.tr('"', '\'')}"
       elsif autorequire.first.is_a?(String)
         return ", require: '#{autorequire.first}'"
       else
@@ -30,33 +50,41 @@ module Rocktumbler
       end
     end
 
-    def generate_gem_source(source_options)
-      ['git','github','git_source','source','path','gist','bitbucket'].each do | source_type |
-        return ", #{source_type}: '#{source_options[source_type]}'" if source_options[source_type]
+    def format_source
+      return '' unless @gem_dep.source
+      source_options = @gem_dep.source.options
+      %w(git github git_source source path gist bitbucket).each do |source_type|
+        next unless source_options[source_type]
+        return ", #{source_type}: '#{source_options[source_type]}'"
       end
     end
 
-    def retrieve_gem_information(gem_name)
-      bundled_gem = Bundler.definition.specs.select{|g| g.name == gem_name}.first
+    def retrieve_gem_information(gem_name, max_length = 80)
+      bundled_gem = Bundler.definition.specs.find { |g| g.name == gem_name }
       if bundled_gem
-        OpenStruct.new(summary: bundled_gem.summary.slice(0,80), homepage: bundled_gem.homepage)
+        OpenStruct.new(summary: bundled_gem.summary.slice(0, max_length),
+                       homepage: bundled_gem.homepage)
       else
-        rubygems_gem_information(gem_name)
+        rubygems_gem_info(gem_name, max_length)
       end
     end
 
-    def rubygems_gem_information(gem_name)
-      begin
-        json = open("https://rubygems.org/api/v1/gems/#{gem_name}.json").read
-        gem_info = JSON.parse(json)
-        OpenStruct.new(summary: gem_info['info'].slice(0,80), homepage: gem_info['homepage_uri'])
-      rescue OpenURI::HTTPError => e
-        if e.message == '404 Not Found'
-          raise GemInformationNotFoundError, "No details found locally or on rubygems for '#{gem_name}'"
-        else
-          raise e
-        end
+    def rubygems_gem_info(gem_name, max_length = 80)
+      gem_info = rubygems_gem_info_json(gem_name)
+      OpenStruct.new(summary: gem_info['info'].slice(0, max_length),
+                     homepage: gem_info['homepage_uri'])
+    rescue OpenURI::HTTPError => e
+      if e.message == '404 Not Found'
+        raise GemInformationNotFoundError,
+              "No details found locally or on rubygems for '#{gem_name}'"
+      else
+        raise e
       end
     end
+
+    def rubygems_gem_info_json(gem_name)
+      json = open("https://rubygems.org/api/v1/gems/#{gem_name}.json").read
+      JSON.parse(json)
+    end
   end
 end

data/lib/rocktumbler/gemfile.rb

@@ -1,6 +1,7 @@
 require_relative 'exceptions'
 
 module Rocktumbler
+  # The Gemfile is a class responsible for reading and parsing a Gemfile
   class Gemfile
     attr_accessor :ruby, :source
 
@@ -12,27 +13,25 @@ module Rocktumbler
     end
 
     def read_contents
-      gemfile = File.open(@gemfile_location,'r')
+      gemfile = File.open(@gemfile_location, 'r')
       str = gemfile.read
       gemfile.close
       str
     end
 
     def print_source_and_ruby
-      str = ""
-      str += "#{@source.gsub(/"/,'\'')}\n\n" if @source
-      str += "#{@ruby.gsub(/"/,'\'')}\n\n" if @ruby
+      str = ''
+      str += "#{@source.tr('\"', '\'')}\n" if @source
+      str += "\n#{@ruby.tr('\"', '\'')}\n" if @ruby
       str
     end
 
     def parse_ruby
-      /^(ruby.*)/.match(@gemfile_contents)
-      $1
+      /^(ruby.*)/.match(@gemfile_contents)[1] if @gemfile_contents =~ /^(ruby.*)/
     end
 
     def parse_source
-      /^(source.*)/.match(@gemfile_contents)
-      $1
+      /^(source.*)/.match(@gemfile_contents)[1]
     end
   end
 end

data/lib/rocktumbler/group.rb

@@ -1,20 +1,23 @@
 module Rocktumbler
+  # The Group is a class responsible for outputting a gem group
   class Group
-
     attr_accessor :name
 
-    def initialize(name,gem_dependencies)
+    def initialize(name, gem_dependencies, opts)
       @name = name
-      @gems = gem_dependencies.map{|g| Rocktumbler::Gem.new(g)}
+      @opts = opts
+      @gems = gem_dependencies.map { |g| Rocktumbler::Gem.new(g, @opts) }
     end
 
     def print
-      str = ''
+      str = "\n"
       prepend_spacing = (@name == :default) ? '' : '  '
-      str += "\n\ngroup #{@name.to_s.gsub(/[\[\]]/,'')} do\n" if @name != :default
-      str += @gems.map{|g|g.print(prepend_spacing)}.join
-      str += "end\n" if @name != :default
-      return str
+      if @name != :default
+        str += "\ngroup #{@name.to_s.gsub(/[\[\]]/, '')} do\n"
+      end
+      str += @gems.map { |g| g.print(prepend_spacing) }.join("\n")
+      str += "\nend\n" if @name != :default
+      str
     end
   end
 end

data/lib/rocktumbler/group_filter.rb

@@ -1,7 +1,10 @@
 module Rocktumbler
+  # The GroupFilter is a class responsible for filtering gems into group
+  # and sorting the groups and their gems alphabetically.
   class GroupFilter
-    def initialize(gem_dependencies)
+    def initialize(gem_dependencies, opts)
       @gem_dependencies = gem_dependencies
+      @opts = opts
     end
 
     def filter
@@ -9,16 +12,22 @@ module Rocktumbler
 
       default_gems = gems_by_group.delete([:default])
       default_gems.sort!
-      groups = [Rocktumbler::Group.new(:default,default_gems)]
+      groups = [Rocktumbler::Group.new(:default, default_gems, @opts)]
 
-      gems_by_group.each do | group, gems |
+      gems_by_group_sorted = sort_groups(gems_by_group, default_gems)
+
+      groups.concat(gems_by_group_sorted)
+    end
+
+    private
+
+    def sort_groups(gems_by_group, default_gems)
+      gems_by_group.inject([]) do |arr, (group, gems)|
         gems_unique_to_group = gems - default_gems
         gems_unique_to_group.sort!
         gems_unique_to_group.uniq!
-        groups << Rocktumbler::Group.new(group,gems_unique_to_group)
+        arr << Rocktumbler::Group.new(group, gems_unique_to_group, @opts)
       end
-
-      return groups
     end
   end
 end

data/lib/rocktumbler/option.rb

@@ -0,0 +1,54 @@
+require 'optparse'
+require 'pp'
+
+module Rocktumbler
+  class Option
+    #
+    # Return a structure describing the options.
+    #
+    def self.parse(args)
+      # The options specified on the command line will be collected in *options*.
+      # We set default values here.
+      options = OpenStruct.new
+      options.gem_info = false
+      options.gem_homepage = false
+      options.skip_write = false
+
+      opt_parser = OptionParser.new do |opts|
+        opts.banner = "Usage: tumble [options]"
+
+        opts.separator ""
+        opts.separator "Specific options:"
+
+        opts.on("-i", "--info", "Display gem info comment.") do |docs|
+          options.gem_info = true
+        end
+
+        opts.on("-d", "--homepage", "Display gem homepage comment.") do |docs|
+          options.gem_homepage = true
+        end
+
+        opts.on("-s", "--skip-write", "Skip writing of Gemfile") do |docs|
+          options.skip_write = true
+        end
+
+        opts.separator ""
+        opts.separator "Common options:"
+
+        # No argument, shows at tail.  This will print an options summary.
+        opts.on_tail("-h", "--help", "Show this message") do
+          puts opts
+          exit
+        end
+
+        opts.on_tail("--version", "Show version") do
+          puts Rocktumbler::VERSION
+          exit
+        end
+      end
+
+      opt_parser.parse!(args)
+      options
+    end
+  end
+end

data/lib/rocktumbler/tumbler.rb

@@ -1,44 +1,54 @@
 require_relative 'exceptions'
 
 module Rocktumbler
+  # The Tumbler class is responsible for executing the top level tumble method
+  # and reads, parses, cleans, writes and verifies the new gemfile.
   class Tumbler
-    def initialize(location=Bundler.default_gemfile)
+    def initialize(location = Bundler.default_gemfile)
+      @opts = {}
       @gemfile_location = location
       @bundler_dependencies = parse_gemfile(@gemfile_location)
       @gemfile = Rocktumbler::Gemfile.new(location)
     end
 
-    def tumble(opts={})
-      groups = Rocktumbler::GroupFilter.new(@bundler_dependencies).filter
+    def tumble(args = ARGV)
+      @opts = Option.parse(args)
+      groups = Rocktumbler::GroupFilter.new(@bundler_dependencies, @opts).filter
       clean_gemfile_str = @gemfile.print_source_and_ruby
       clean_gemfile_str << groups.map(&:print).join
       compare_to_original_gemfile(clean_gemfile_str)
-      write(clean_gemfile_str) unless opts[:skip_write]
-      return clean_gemfile_str
+      write(clean_gemfile_str) unless @opts.skip_write
+      clean_gemfile_str
     end
 
     def compare_to_original_gemfile(clean_gemfile_str)
-      temp_gemfile = Tempfile.new('Gemfile.temp')
-      temp_gemfile.write(clean_gemfile_str)
-      temp_gemfile.close
+      temp_gemfile = write_temp_gemfile(clean_gemfile_str)
       temp_bundler_dependencies = parse_gemfile(temp_gemfile.path)
       diff = @bundler_dependencies - temp_bundler_dependencies
 
       if diff.empty?
         return true
       else
-        raise IncomparableGemfileError, "Clean Gemfile is not comparable to the existing Gemfile. The following gems are missing : #{diff.map(&:name).to_s}."
+        fail IncomparableGemfileError, "Clean Gemfile is not comparable to the\
+ existing Gemfile. The following gems are missing : #{diff.map(&:name)}."
       end
     end
 
     def write(clean_gemfile_str)
-      gemfile = File.open(@gemfile_location,'w')
+      gemfile = File.open(@gemfile_location, 'w')
       gemfile.write(clean_gemfile_str)
       gemfile.close
     end
 
     private
 
+    def write_temp_gemfile(clean_gemfile_str)
+      temp_gemfile = Tempfile.new('Gemfile.temp')
+      temp_gemfile.write(clean_gemfile_str)
+      temp_gemfile.close
+      temp_gemfile
+    end
+
     def parse_gemfile(location)
       builder = Bundler::Dsl.new
       builder.eval_gemfile(location)

data/lib/rocktumbler/version.rb

@@ -1,3 +1,4 @@
+# Rocktumbler module
 module Rocktumbler
-  VERSION = "0.1.2"
+  VERSION = '0.1.3'
 end

data/lib/rocktumbler.rb

@@ -3,11 +3,13 @@ require 'ostruct'
 require 'tempfile'
 require 'bundler'
 
+# Rocktumbler module
 module Rocktumbler
   autoload :Tumbler,       'rocktumbler/tumbler'
   autoload :Group,         'rocktumbler/group'
   autoload :GroupFilter,   'rocktumbler/group_filter'
   autoload :Gem,           'rocktumbler/gem'
   autoload :Gemfile,       'rocktumbler/gemfile'
-  autoload :Version,       'rocktumbler/version'
+  autoload :VERSION,       'rocktumbler/version'
+  autoload :Option,        'rocktumbler/option'
 end

data/rocktumbler.gemspec

@@ -4,21 +4,24 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'rocktumbler/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "rocktumbler"
+  spec.name          = 'rocktumbler'
   spec.version       = Rocktumbler::VERSION
-  spec.authors       = ["Simon Reed"]
-  spec.email         = ["simonpreed@gmail.com"]
+  spec.authors       = ['Simon Reed']
+  spec.email         = ['simonpreed@gmail.com']
 
-  spec.summary       = %q{Polish your Gemfile to make sure it remains consistent.}
-  spec.description   = %q{Polish your Gemfile to make sure it remains consistent.}
-  spec.homepage      = "https://github.com/simonreed/rocktumbler"
-  spec.license       = "MIT"
+  spec.summary       = 'Polish your Gemfile to make sure it remains consistent.'
+  spec.description   = 'Polish your Gemfile to make sure it remains consistent.'
+  spec.homepage      = 'https://github.com/simonreed/rocktumbler'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f|
+    f.match(%r{^(test|spec|features)/})
+  }
   spec.executables   = %w(tumble)
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency('rspec', '~> 3.2.0')
 
-  spec.add_runtime_dependency "bundler", "~> 1.8"
+  spec.add_runtime_dependency 'bundler', '~> 1.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rocktumbler
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Simon Reed
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-24 00:00:00.000000000 Z
+date: 2015-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -24,20 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.7'
 description: Polish your Gemfile to make sure it remains consistent.
 email:
 - simonpreed@gmail.com
@@ -61,10 +75,9 @@ files:
 - lib/rocktumbler/gemfile.rb
 - lib/rocktumbler/group.rb
 - lib/rocktumbler/group_filter.rb
+- lib/rocktumbler/option.rb
 - lib/rocktumbler/tumbler.rb
 - lib/rocktumbler/version.rb
-- rocktumbler-0.1.0.gem
-- rocktumbler-0.1.1.gem
 - rocktumbler.gemspec
 homepage: https://github.com/simonreed/rocktumbler
 licenses:
@@ -86,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Polish your Gemfile to make sure it remains consistent.