hash_syntax 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Michael Edgar
+
+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 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/README.rdoc

@@ -0,0 +1,17 @@
+= hash_syntax
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2011 Michael Edgar. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'rake'
+
+require './lib/hash_syntax/version'
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "hash_syntax"
+    gem.summary = %Q{Converts Ruby files to and from Ruby 1.9's Hash syntax}
+    gem.description = %Q{The new label style for Ruby 1.9's literal hash keys
+is somewhat controversial. This tool seamlessly converts Ruby files between
+the old and the new syntaxes.}
+    gem.email = "michael.j.edgar@dartmouth.edu"
+    gem.homepage = "http://github.com/michaeledgar/hash_syntax"
+    gem.authors = ["Michael Edgar"]
+    gem.add_dependency 'object_regex', '~> 1.0.1'
+    gem.add_dependency 'trollop', '~> 1.16.2'
+    gem.add_development_dependency 'rspec', '>= 2.3.0'
+    gem.add_development_dependency "yard", ">= 0"
+    gem.version = HashSyntax::Version::STRING
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/bin/hash_syntax

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby -w
+
+require 'rubygems'
+require 'hash_syntax'
+HashSyntax::Runner.new.run!

data/hash_syntax.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{hash_syntax}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Michael Edgar}]
+  s.date = %q{2011-06-24}
+  s.description = %q{The new label style for Ruby 1.9's literal hash keys
+is somewhat controversial. This tool seamlessly converts Ruby files between
+the old and the new syntaxes.}
+  s.email = %q{michael.j.edgar@dartmouth.edu}
+  s.executables = [%q{hash_syntax}]
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "bin/hash_syntax",
+    "hash_syntax.gemspec",
+    "lib/hash_syntax.rb",
+    "lib/hash_syntax/runner.rb",
+    "lib/hash_syntax/token.rb",
+    "lib/hash_syntax/transformer.rb",
+    "lib/hash_syntax/version.rb",
+    "spec/hash_syntax_spec.rb",
+    "spec/spec.opts",
+    "spec/spec_helper.rb",
+    "spec/transformer_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/michaeledgar/hash_syntax}
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.5}
+  s.summary = %q{Converts Ruby files to and from Ruby 1.9's Hash syntax}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<object_regex>, ["~> 1.0.1"])
+      s.add_runtime_dependency(%q<trollop>, ["~> 1.16.2"])
+      s.add_development_dependency(%q<rspec>, [">= 2.3.0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<object_regex>, ["~> 1.0.1"])
+      s.add_dependency(%q<trollop>, ["~> 1.16.2"])
+      s.add_dependency(%q<rspec>, [">= 2.3.0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<object_regex>, ["~> 1.0.1"])
+    s.add_dependency(%q<trollop>, ["~> 1.16.2"])
+    s.add_dependency(%q<rspec>, [">= 2.3.0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

data/lib/hash_syntax.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby -w
+require 'ripper'
+require 'object_regex'
+require 'trollop'
+
+require 'hash_syntax/token'
+require 'hash_syntax/runner'
+require 'hash_syntax/transformer'
+require 'hash_syntax/version'

data/lib/hash_syntax/runner.rb

@@ -0,0 +1,43 @@
+module HashSyntax
+  class Runner
+    
+    def run!
+      options = gather_options
+      validate_options(options)
+      files = gather_files
+      files.each do |name|
+        transformed_file = Transformer.transform(File.read(name), options)
+        File.open(name, 'w') { |fp| fp.write(transformed_file) }
+      end
+    end
+    
+  private
+    
+    def gather_options
+      Trollop::options do
+        version HashSyntax::Version::STRING
+        banner <<-EOF
+hash_syntax #{HashSyntax::Version::STRING} by Michael Edgar (adgar@carboni.ca)
+
+Automatically convert hash symbol syntaxes in your Ruby code.
+EOF
+        opt :"to-18", 'Convert to Ruby 1.8 syntax (:key => value)', :short => '-o'
+        opt :"to-19", 'Convert to Ruby 1.9 syntax (key: value)', :short => '-n'
+      end
+    end
+    
+    def validate_options(opts)
+      Trollop::die 'Must specify --to_18 or --to_19' unless opts[:"to-18"] or opts[:"to-19"]
+    end
+    
+    AUTO_SUBDIRS = %w(app ext features lib spec test)
+    
+    def gather_files
+      if ARGV.empty?
+        AUTO_SUBDIRS.map { |dir| Dir["#{Dir.pwd}/#{dir}/**/*.rb"] }.flatten
+      else
+        ARGV
+      end
+    end
+  end
+end

data/lib/hash_syntax/token.rb

@@ -0,0 +1,23 @@
+module HashSyntax
+  Token = Struct.new(:type, :body, :line, :col) do
+    # Unpacks the token from Ripper and breaks it into its separate components.
+    #
+    # @param [Array<Array<Integer, Integer>, Symbol, String>] token the token
+    #     from Ripper that we're wrapping
+    def initialize(token)
+      (self.line, self.col), self.type, self.body = token
+    end
+    
+    def width
+      body.size
+    end
+    
+    def reg_desc
+      if type == :on_op && body == '=>'
+        'hashrocket'
+      else
+        type.to_s.sub(/^on_/, '')
+      end
+    end
+  end
+end

data/lib/hash_syntax/transformer.rb

@@ -0,0 +1,70 @@
+module HashSyntax
+  module Transformer
+    MATCH_18 = ObjectRegex.new('symbeg (ident | kw) sp? hashrocket')
+    MATCH_19 = ObjectRegex.new('label')
+    
+    extend self
+    
+    def transform(input_text, options)
+      tokens = extract_tokens(input_text)
+      if options[:"to-18"]
+        transform_to_18(input_text, tokens, options)
+      elsif options[:"to-19"]
+        transform_to_19(input_text, tokens, options)
+      else
+        raise ArgumentError.new('Either :to_18 or :to_19 must be specified.')
+      end
+    end
+    
+  private
+    
+    def extract_tokens(text)
+      swizzle_parser_flags do
+        Ripper.lex(text).map { |token| Token.new(token) }
+      end
+    end
+    
+    def swizzle_parser_flags
+      old_w = $-w
+      old_v = $-v
+      old_d = $-d
+      $-w = $-v = $-d = false
+      yield
+    ensure
+      $-w = old_w
+      $-v = old_v
+      $-d = old_d
+    end
+    
+    def transform_to_18(input_text, tokens, options)
+      lines = input_text.lines.to_a  # eagerly expand lines
+      matches = MATCH_19.all_matches(tokens)
+      line_adjustments = Hash.new(0)
+      matches.each do |label_list|
+        label = label_list.first
+        lines[label.line - 1][label.col + line_adjustments[label.line],label.width] = ":#{label.body[0..-2]} =>"
+        line_adjustments[label.line] += 3  # " =>" is inserted and is 3 chars
+      end
+      lines.join
+    end
+    
+    def transform_to_19(input_text, tokens, options)
+      lines = input_text.lines.to_a  # eagerly expand lines
+      matches = MATCH_18.all_matches(tokens)
+      line_adjustments = Hash.new(0)
+      matches.each do |match_tokens|
+        symbeg, ident, *spacing_and_comments, rocket = match_tokens
+        lines[symbeg.line - 1][symbeg.col + line_adjustments[symbeg.line],1] = ''
+        lines[ident.line - 1].insert(ident.col + line_adjustments[ident.line] + ident.width - 1, ':')
+        lines[rocket.line - 1][rocket.col + line_adjustments[rocket.line],2] = ''
+        if spacing_and_comments.last != nil && spacing_and_comments.last.type == :on_sp
+          lines[rocket.line - 1][rocket.col + line_adjustments[rocket.line] - 1,1] = ''
+          line_adjustments[rocket.line] -= 3  # chomped " =>"
+        else
+          line_adjustments[rocket.line] -= 2  # only chomped the "=>"
+        end
+      end
+      lines.join
+    end
+  end
+end

data/lib/hash_syntax/version.rb

@@ -0,0 +1,14 @@
+module HashSyntax
+  module Version
+    MAJOR = 1
+    MINOR = 0
+    PATCH = 0
+    BUILD = ''
+
+    if BUILD.empty?
+      STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+    else
+      STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
+    end
+  end
+end

data/spec/hash_syntax_spec.rb

@@ -0,0 +1,7 @@
+require_relative 'spec_helper'
+
+describe "HashSyntax" do
+  it "has a version" do
+    HashSyntax::Version::STRING.should be >= "1.0.0"
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'hash_syntax'
+require 'rspec'
+require 'rspec/autorun'
+
+RSpec::Matchers.define :transform_to do |output, target|
+  match do |input|
+    @result = HashSyntax::Transformer.transform(input, target => true)
+    @result == output
+  end
+  
+  failure_message_for_should do |input|
+    "expected '#{input}' to correct to #{output}, not #{@result}"
+  end
+  
+  diffable
+end
+
+RSpec.configure do |config|
+  
+end

data/spec/transformer_spec.rb

@@ -0,0 +1,88 @@
+require_relative 'spec_helper'
+
+describe HashSyntax::Transformer do
+  describe 'transforming from 1.8 to 1.9 syntax' do
+    it 'can transform a simple hash' do
+      'x = {:foo => :bar}'.should transform_to('x = {foo: :bar}', :to_19)
+    end
+  
+    it 'transforms all hashes in a block of code' do
+      input = %q{
+with_jumps_redirected(:break => ensure_body[1], :redo => ensure_body[1], :next => ensure_body[1],
+                      :return => ensure_body[1], :rescue => ensure_body[1],
+                      :yield_fail => ensure_body[1]) do
+  rescue_target, yield_fail_target =
+      build_rescue_target(node, result, rescue_body, ensure_block,
+                          current_rescue, current_yield_fail)
+  walk_body_with_rescue_target(result, body, body_block, rescue_target, yield_fail_target)
+end
+}
+      output = %q{
+with_jumps_redirected(break: ensure_body[1], redo: ensure_body[1], next: ensure_body[1],
+                      return: ensure_body[1], rescue: ensure_body[1],
+                      yield_fail: ensure_body[1]) do
+  rescue_target, yield_fail_target =
+      build_rescue_target(node, result, rescue_body, ensure_block,
+                          current_rescue, current_yield_fail)
+  walk_body_with_rescue_target(result, body, body_block, rescue_target, yield_fail_target)
+end
+}
+      input.should transform_to(output, :to_19)
+    end
+    
+    it 'transforms all hashes in a block of code without minding tight spacing' do
+      input = %q{
+with_jumps_redirected(:break=>ensure_body[1], :redo=>ensure_body[1], :next=>ensure_body[1],
+                      :return=>ensure_body[1], :rescue=>ensure_body[1],
+                      :yield_fail=>ensure_body[1]) do
+  rescue_target, yield_fail_target =
+      build_rescue_target(node, result, rescue_body, ensure_block,
+                          current_rescue, current_yield_fail)
+  walk_body_with_rescue_target(result, body, body_block, rescue_target, yield_fail_target)
+end
+}
+      output = %q{
+with_jumps_redirected(break:ensure_body[1], redo:ensure_body[1], next:ensure_body[1],
+                      return:ensure_body[1], rescue:ensure_body[1],
+                      yield_fail:ensure_body[1]) do
+  rescue_target, yield_fail_target =
+      build_rescue_target(node, result, rescue_body, ensure_block,
+                          current_rescue, current_yield_fail)
+  walk_body_with_rescue_target(result, body, body_block, rescue_target, yield_fail_target)
+end
+}
+      input.should transform_to(output, :to_19)
+    end
+
+  end
+
+  describe 'transforming from 1.9 to 1.8 syntax' do
+    it 'can transform a simple hash' do
+      'x = {foo: :bar}'.should transform_to('x = {:foo => :bar}', :to_18)
+    end
+
+    it 'transforms all hashes in a block of code' do
+      input = %q{
+with_jumps_redirected(break: ensure_body[1], redo: ensure_body[1], next: ensure_body[1],
+                      return: ensure_body[1], rescue: ensure_body[1],
+                      yield_fail: ensure_body[1]) do
+  rescue_target, yield_fail_target =
+      build_rescue_target(node, result, rescue_body, ensure_block,
+                          current_rescue, current_yield_fail)
+  walk_body_with_rescue_target(result, body, body_block, rescue_target, yield_fail_target)
+end
+}
+      output = %q{
+with_jumps_redirected(:break => ensure_body[1], :redo => ensure_body[1], :next => ensure_body[1],
+                      :return => ensure_body[1], :rescue => ensure_body[1],
+                      :yield_fail => ensure_body[1]) do
+  rescue_target, yield_fail_target =
+      build_rescue_target(node, result, rescue_body, ensure_block,
+                          current_rescue, current_yield_fail)
+  walk_body_with_rescue_target(result, body, body_block, rescue_target, yield_fail_target)
+end
+}
+      input.should transform_to(output, :to_18)
+    end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: hash_syntax
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Michael Edgar
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-24 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: object_regex
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: trollop
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.16.2
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: |-
+  The new label style for Ruby 1.9's literal hash keys
+  is somewhat controversial. This tool seamlessly converts Ruby files between
+  the old and the new syntaxes.
+email: michael.j.edgar@dartmouth.edu
+executables: 
+- hash_syntax
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- LICENSE
+- README.rdoc
+- Rakefile
+- bin/hash_syntax
+- hash_syntax.gemspec
+- lib/hash_syntax.rb
+- lib/hash_syntax/runner.rb
+- lib/hash_syntax/token.rb
+- lib/hash_syntax/transformer.rb
+- lib/hash_syntax/version.rb
+- spec/hash_syntax_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/transformer_spec.rb
+homepage: http://github.com/michaeledgar/hash_syntax
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Converts Ruby files to and from Ruby 1.9's Hash syntax
+test_files: []
+