alphabetize 0.0.1 → 0.1.0

data/README.md

@@ -1,6 +1,6 @@
 # Alphabetize
 
-TODO: Write a gem description
+Ruby gem to soothe your OCDs by alphabetizing your Gemfile
 
 ## Installation
 
@@ -18,7 +18,9 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Go to root level of your rails app and run
+
+	$ alphabetize
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,94 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+
+# Most of these rake tasks were obtained from jekyll's Rakefile: #src TODO
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), *%w[lib]))
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  puts "Line read: #{line}"
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+task :gemspec do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg|coverage)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  gem.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end

data/alphabetize.gemspec

@@ -1,5 +1,7 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/alphabetize/version', __FILE__)
+$:.unshift File.dirname(__FILE__)
+
+require 'lib/alphabetize'
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Vidur Murali"]
@@ -14,4 +16,25 @@ Gem::Specification.new do |gem|
   gem.name          = "alphabetize"
   gem.require_paths = ["lib"]
   gem.version       = Alphabetize::VERSION
-end
+
+  # = MANIFEST =
+  gem.files = %w[
+    Gemfile
+    LICENSE
+    README.md
+    Rakefile
+    alphabetize.gemspec
+    bin/alphabetize
+    lib/alphabetize.rb
+    test/helper.rb
+    test/sample_Gemfiles/mixed_Gemfile
+    test/sample_Gemfiles/out_regular_chunks_Gemfile
+    test/sample_Gemfiles/out_static_chunks_Gemfile
+    test/sample_Gemfiles/regular_chunks_Gemfile
+    test/sample_Gemfiles/simple_Gemfile
+    test/sample_Gemfiles/static_chunks_Gemfile
+    test/test_alphabetize.rb
+  ]
+  # = MANIFEST =
+
+end  

data/lib/alphabetize.rb

@@ -1,37 +1,144 @@
-require "alphabetize/version"
+$:.unshift File.dirname(__FILE__) # For use/testing when no gem is installed
+
+# The Gemfile is parsed into    file_chunks array
+# Each chunk has the following attributes:  
+#   :type - :static (don't sort them), :regular, :group (official group, use the header, end correctly)
+#   :header - the line that prepends the chunk
+#   :gem_hash - the hash of gems that belong to this chunk
+# 
 
 module Alphabetize
-  def alphabetize_file
+  VERSION = "0.1.0"
+
+  def self.alphabetize_file
+    filename = "Gemfile"
     file = File.new(filename)
 
     lines = file.readlines
-    lineHash = gem_hash(lines)
+    puts "File Lines: #{lines.inspect}"
+    file_chunks = make_chunky(lines)
+
+    puts "Chunks: #{file_chunks.inspect}"
 
     backupFilename = "old_#{filename}"
     %x( mv #{filename} #{backupFilename})
 
     file = File.open(filename, 'w')
-    file.truncate(0) # clear the file
-    lineHash.keys.sort.each do |gem|
-      line = lineHash[gem]
-      file.puts(line)
+    # file.truncate(0) # clear the file
+
+    file_chunks.each do |chunk|
+      if chunk[:type] == :static
+        print_gem_hash(file, chunk[:gem_hash])
+      elsif chunk[:type] == :group
+        file.puts(chunk[:header])
+        print_gem_hash(file, chunk[:gem_hash])
+        file.puts("end")
+      elsif chunk[:type] == :regular
+        print_gem_hash(file, chunk[:gem_hash])
+      else
+        raise "This chunk has some wierd type!"
+      end
+
+
+      # chunk.keys.sort.each do |gem|
+      #   line = chunk[gem]
+      #   file.puts(line)
+      # end
+      file.puts("")
     end
+
     file.close
 
   end
 
-  def gem_hash(lines)
-    hash = {}
+  private
+  def self.make_chunky(lines)
+    chunks = []
 
+    chunk = {}
+    chunk_gem_lines = []
     lines.each do |line|
+      puts "*            Processing line: #{line}"
+      if line != "\n"
+        if line.match(/##/) # static chunk
+          chunk[:type] = :static
+          puts "Thinks its static"
+          chunk[:gem_hash] = gem_hash([line])
+          chunks << chunk
+          chunk = {}
+          chunk_gem_lines = []
+
+        elsif line.match(/do/) # official start of a group
+          chunk[:type] = :group
+          chunk[:header] = line
+
+        elsif line.match(/^end/) # official end of a group
+          puts "Thinks its a group"
+          chunk[:gem_hash] = gem_hash(chunk_gem_lines)
+          chunks << chunk
+          chunk = {}
+          chunk_gem_lines = []
+
+        else # regular gem line
+          chunk[:type] = :regular if chunk == {} # start of a regualr chunk
+          chunk_gem_lines << line
+        end
+
+      elsif line == "\n" and chunk != {}  # this is the end of some regular chunk
+        puts "Thinks its regular"
+        chunk[:gem_hash] = gem_hash(chunk_gem_lines)
+        chunks << chunk
+        chunk = {}
+        chunk_gem_lines = []
+
+      else # two new line characters in a row
+        puts "**** Skipping line: #{line}"
+        # do nothing
+      end
+
+
+      # if line contains '##'
+      #   mark chunk as :static
+      # if line contains 'do'
+      #   mark chunk as :group
+      # 
+      # if line == "\n" and !chunk_gem_lines.empty?
+      #   chunk[:gem_hash] = gem_hash(chunk_gem_lines)
+      #   chunks << chunk
+      #   chunk_gem_lines = [] # reset chunk lines
+      # else
+      #   chunk_gem_lines << line if line != "\n"
+      # end
+    end
+
+    if chunk != {}
+      chunk[:gem_hash] = gem_hash(chunk_gem_lines)
+      chunks << chunk
+    end
+
+    chunks
+  end
+
+  def self.gem_hash(lines)
+    hash = {}
+    puts "-------- Inspecting lines: #{lines.inspect}"
+    lines.each do |line|
+      puts "Line: #{line}"
       match_data = line.scan(/(\"([^"]*)\")|(\'([^']*)\')/)
       # The gem is either the second element or the 4th element of the array
       gem ||= match_data[0][1]
       gem ||= match_data[0].last
-
+      puts "Found gem: #{gem}"
       hash[gem] = line
     end
 
     hash
   end
+
+  def self.print_gem_hash(out, hash)
+    hash.keys.sort.each do |gem|
+      line = hash[gem]
+      out.puts(line)
+    end
+  end
 end

data/test/helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+
+require 'shoulda'
+
+class Test::Unit::TestCase
+
+  # def some_helper_function(args)
+  #   # ...
+  # end
+  
+end

data/test/sample_Gemfiles/mixed_Gemfile

@@ -0,0 +1,46 @@
+gem 'rails', '3.1.3'
+gem 'pg'
+gem 'jquery-rails'
+gem "zurbfoundation"
+gem 'devise'
+gem 'icalendar'
+gem 'omniauth-facebook'
+gem 'cancan'
+gem 'nested_form', :git => 'https://github.com/jweslley/nested_form.git'
+gem 'datejsrails'
+
+group :assets do
+  gem 'sass-rails',   '~> 3.1.5'
+  gem 'coffee-rails', '~> 3.1.1'
+  gem 'uglifier', '>= 1.0.3'
+end
+
+group :development do
+  gem 'kumade', '~> 0.8.1'
+  gem 'letter_opener'
+  gem 'ruby-debug19', :platforms => :ruby_19#, :require => 'ruby-debug'
+end
+
+group :development, :test do
+  gem 'factory_girl_rails'
+  gem 'rspec-rails', '~> 2.7'
+  gem 'shoulda-matchers'
+  gem 'email_spec'
+  gem 'guard-livereload'
+  gem 'yajl-ruby' # speed up LiveReload JSON
+  gem 'rb-notifu', :platforms => :mingw
+  gem 'rb-fchange', :platforms => :mingw
+  gem 'eventmachine', '>= 1.0.0.beta.4', :platforms => :mingw
+end
+
+group :test do
+  gem "capybara", '~> 1.1.2' # for spec/requests
+  gem 'launchy' # for save_and_open_page
+  gem 'spork'
+  gem 'guard-spork'
+  gem 'rb-fsevent'
+  gem 'guard-rspec'
+  gem 'simplecov', '~> 0.5.4'
+  gem 'shoulda', '~> 2.11.3'
+  gem 'factory_girl_rails'
+end

data/test/sample_Gemfiles/simple_Gemfile

@@ -0,0 +1,21 @@
+gem 'fixed-gem', '3.2.1' ## Don't want this to move from line 1
+gem 'bcrypt-ruby',  '3.0.1'
+gem 'jquery-rails', '2.0.2'
+
+gem 'fixed-gem', '3.2.1' ## Don't want this to move from line 5
+gem 'pg',           '0.13.2'
+gem 'uglifier',     '1.0.3'
+
+group :development do
+  gem 'private_pub'
+  gem 'sass-rails',   '3.2.3'
+  gem 'rails',        '3.2.3'
+  gem 'js-routes'
+  gem 'rails-erd'
+  gem 'growl'
+end
+
+gem 'shoulda-matchers'
+gem 'spork'
+gem 'faker'
+gem 'simplecov', :require => false

data/test/test_alphabetize.rb

@@ -0,0 +1,4 @@
+require './alphabetize/lib/alphabetize'
+
+%x(cp test_Gemfile Gemfile)
+Alphabetize::alphabetize_file

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alphabetize
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-25 00:00:00.000000000Z
+date: 2012-07-02 00:00:00.000000000Z
 dependencies: []
 description: Alphabetizes your gemfile
 email:
@@ -19,7 +19,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
 - Gemfile
 - LICENSE
 - README.md
@@ -27,7 +26,14 @@ files:
 - alphabetize.gemspec
 - bin/alphabetize
 - lib/alphabetize.rb
-- lib/alphabetize/version.rb
+- test/helper.rb
+- test/sample_Gemfiles/mixed_Gemfile
+- test/sample_Gemfiles/out_regular_chunks_Gemfile
+- test/sample_Gemfiles/out_static_chunks_Gemfile
+- test/sample_Gemfiles/regular_chunks_Gemfile
+- test/sample_Gemfiles/simple_Gemfile
+- test/sample_Gemfiles/static_chunks_Gemfile
+- test/test_alphabetize.rb
 homepage: https://github.com/vyder/alphabetize
 licenses: []
 post_install_message: 
@@ -53,4 +59,13 @@ signing_key:
 specification_version: 3
 summary: Please check how far I've got with the file parsing before you use this gem.
   It does create a backup of your gemfile in case things go seriously wrong.'
-test_files: []
+test_files:
+- test/helper.rb
+- test/sample_Gemfiles/mixed_Gemfile
+- test/sample_Gemfiles/out_regular_chunks_Gemfile
+- test/sample_Gemfiles/out_static_chunks_Gemfile
+- test/sample_Gemfiles/regular_chunks_Gemfile
+- test/sample_Gemfiles/simple_Gemfile
+- test/sample_Gemfiles/static_chunks_Gemfile
+- test/test_alphabetize.rb
+has_rdoc: 

data/.gitignore

@@ -1,17 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/lib/alphabetize/version.rb

@@ -1,3 +0,0 @@
-module Alphabetize
-  VERSION = "0.0.1"
-end