synecdoche 0.1.0

data/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2012 Dan Swain
+
+MIT License
+
+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.md

@@ -0,0 +1,109 @@
+# Synecdoche
+
+Synecdoche: 
+>_a figure of speech by which a part is put for the
+>whole (as fifty sail for fifty ships), the whole for a part (as
+>society for high society), the species for the genus (as cutthroat for
+>assassin), the genus for the species (as a creature for a man), or the
+>name of the material for the thing made (as boards for stage)_
+>[m-w.com](http://www.merriam-webster.com/dictionary/synecdoche)
+
+Synecdoche is a Ruby gem that enables you to include parts of a file,
+class, or module.  It is useful for testing specific methods that can
+stand alone but are part of a larger module that has potentially
+complex dependencies.
+
+In some sense, Synecdoche solves a problem that shouldn't exist.  Your
+code _should_ be written so that each logical piece of code is
+testable on its own.  However, in the real world, you sometimes have
+to work with code involving large modules with complex dependencies.
+
+Synecdoche is a tool that you can use to refactor complex code.  It
+allows you to test the parts of the code that you want to refactor
+while they are still embedded in larger modules.  Then, once you have
+  tests, you can refactor with confidence, and eventually you won't
+  need Synecdoche anymore.
+
+## License
+
+Synecdoche is released under the 
+[MIT license](http://en.wikipedia.org/wiki/MIT_License). 
+See the LICENSE file.
+
+## Requirements
+
+Synecdoche should work on any Ruby.  It's only been tested on Ruby
+1.9.3 so far, though.
+
+## Installation
+
+_Note: The gem hasn't been published yet and I haven't added the
+Rakefile yet.  These tasks will be done soon._
+
+If your system is set up to allow it, you can just do
+
+    gem install synecdoche
+
+Or,  if you prefer a more hands-on approach or want to hack at the source:
+
+    git clone git://github.com/simplifi/synecdoche.git
+    cd synecdoche
+    rake install
+
+If you are working on a system where you need to `sudo gem install`
+you can do
+
+    rake gem 
+    sudo gem install synecdoche
+
+As always, you can `rake -T` to find out what other rake tasks we have
+provided.
+
+## Basic Usage
+
+Suppose we have a class `SomeClass` defined in `some_class.rb`:
+
+    # some_class.rb
+
+    # potentially lots of dependencies here
+
+    class SomeClass
+      # other methods, etc...
+
+      # a method we'd like to refactor
+      def double x
+        2*x
+      end
+
+    end
+
+Using Synecdoche, we could extract `SomeClass#double` into a smaller
+class without needing to import all of `some_class.rb`:
+
+    # spec/test_double_method.rb
+
+    require 'synecdoche'
+
+    class PartialSomeClass < Synecdoche::PartialClass
+      include_method :double
+    end
+
+If the directories are set up right, Synecdoche will guess the file
+name (using Rails' camel casing guidelines) of the source file.
+Otherwise we could do `include_method :double, :file_name =>
+"path/to/some_class.rb"`.
+
+More docs coming soon.
+    
+## Contributing
+
+The usual github process applies here:
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+You can also contribute to the author's ego by letting him know that
+you find String Eater useful ;)

data/Rakefile

@@ -0,0 +1,18 @@
+require 'rake/clean'
+
+project_name = "synecdoche"
+
+desc "Run rspec spec/ (compile if needed)"
+task :test do
+  sh "rspec spec/"
+end
+
+desc "Create gem"
+task :gem => "#{project_name}.gemspec" do
+  sh "gem build #{project_name}.gemspec"
+end
+
+desc "Install using 'gem install'"
+task :install => :gem do
+  sh "gem install #{project_name}"
+end

data/examples/partial_class.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.expand_path("../lib", File.dirname(__FILE__)))
+
+require 'synecdoche'
+
+class PartialSomeClass < Synecdoche::PartialClass
+  include_method :double
+end
+
+c = PartialSomeClass.new
+
+puts c.double(2)

data/examples/some_class.rb

@@ -0,0 +1,5 @@
+class SomeClass
+  def double x
+    2*x
+  end
+end

data/lib/partial_class/partial_class.rb

@@ -0,0 +1,33 @@
+module Synecdoche
+  class PartialClass
+    def self.parser
+      @parser ||= Synecdoche::SourceParser.new
+    end
+
+    def self.from_file file_name
+      @file_name = file_name
+    end
+
+    def self.part_of class_name
+      @class_name = class_name
+    end
+
+    def self.class_name
+      @class_name ||= name.gsub(/\APartial/, '')
+    end
+
+    def self.file_name
+      @file_name ||= (Synecdoche::SourceParser::underscore(class_name) + ".rb")
+    end
+
+    def self.include_method name, opts={}
+      from_file(opts[:file_name]) if opts[:file_name] 
+      part_of(opts[:class_name]) if opts[:class_name]
+
+      parser.ensure_parsed(file_name)
+      source = parser.method_source_in_class(name, class_name)
+
+      class_eval(source)
+    end
+  end
+end

data/lib/source_parser/source_parser.rb

@@ -0,0 +1,38 @@
+require 'rdoc'
+require 'rdoc/rdoc'
+
+module Synecdoche
+  class SourceParser
+    def self.underscore string
+      string.gsub(/::/, '/').
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr("-", "_").
+        downcase
+    end
+
+    def initialize
+      @rdoc = RDoc::RDoc.new
+      @rdoc.options = RDoc::Options.new
+    end
+
+    def parse_file file_name
+      @file_name = file_name
+      @file = @rdoc.parse_files([file_name]).first
+    end
+
+    def ensure_parsed file_name
+      unless @file && (@file_name == file_name)
+        parse_file(file_name)
+      end
+    end
+
+    def method_source_in_class method_name, class_name
+      raise "No file parsed" unless @file
+      klass = @file.classes.find{|c| c.name == class_name.to_s}
+      klass.method_list.find do |m|
+        m.name == method_name.to_s
+      end.tokens_to_s
+    end
+  end
+end

data/lib/synecdoche.rb

@@ -0,0 +1,5 @@
+module Synecdoche
+  autoload :SourceParser, 'source_parser/source_parser'
+  autoload :PartialClass, 'partial_class/partial_class'
+  autoload :VERSION, 'version/version'
+end

data/lib/version/version.rb

@@ -0,0 +1,9 @@
+module Synecdoche
+  module VERSION
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+    PRE   = nil
+    STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: synecdoche
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Dan Swain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-24 00:00:00.000000000 Z
+dependencies: []
+description: Include parts of a class in another class.
+email:
+- dan@simpli.fi
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/synecdoche.rb
+- lib/partial_class/partial_class.rb
+- lib/source_parser/source_parser.rb
+- lib/version/version.rb
+- examples/partial_class.rb
+- examples/some_class.rb
+- LICENSE
+- Rakefile
+- README.md
+homepage: http://github.com/simplifi/synecdoche
+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.24
+signing_key: 
+specification_version: 3
+summary: Include parts of a class in another class.  Useful for refactoring large
+  modules with complex dependencies.
+test_files: []