morph 0.1.0

data/CHANGELOG

@@ -0,0 +1 @@
+v0.1.0. initial release

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright 2008 Rob McKinnon
+
+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 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/Manifest

@@ -0,0 +1,9 @@
+CHANGELOG
+examples/forger.rb
+examples/hubbit.rb
+lib/morph.rb
+LICENSE
+README
+spec/morph_spec.rb
+spec/spec.opts
+Manifest

data/README

@@ -0,0 +1,155 @@
+Morph allows you to emerge class definitions via calling assignment methods.
+Mix with Hpricot for screen scrapping fun.
+
+Here's example code showing Morph playing with Hpricot:
+
+  require 'hpricot'; require 'open-uri'; require 'morph'
+
+  class Hubbit
+    include Morph  # allows class to morph
+
+    def initialize name
+      doc = Hpricot open("http://github.com/#{name}")
+
+      (doc/'label').collect do |node|
+        label = node.inner_text
+        value = node.next_sibling.inner_text.strip
+
+        morph(label, value) # morph magic happening here!
+      end
+    end
+  end
+
+  def Hubbit name; Hubbit.new name; end
+
+
+The model emerges from the data. Let's start by looking up 'why':
+
+  why = Hubbit 'why'
+
+What new methods do we have?
+
+  Hubbit.morph_methods # => ["email", "email=", "name", "name="]
+
+Ah-ha, so we have a name attribute now:
+
+  why.name #=> "why the lucky stiff"
+
+
+Let's add some of why's projects:
+
+  why.projects = %w[shoes hacketyhack camping hoodwinkd hpricot markaby
+                    mousehole parkplace poignant sandbox]
+
+That why's a productive fellow! Note new accessor methods have been added:
+
+  Hubbit.morph_methods # => ["email", "email=", "name", "name=",
+                             "projects", "projects="]
+
+
+Let's do some more morphing:
+
+  dhh = Hubbit 'dhh'
+
+Do we have more methods now?
+
+  Hubbit.morph_methods # => ["blog", "blog=", "company", "company=",
+                             "email", "email=", "location", "location="
+                             "name", "name=", "projects", "projects="]
+
+So, a new company method has appeared:
+
+  dhh.company #=> "37signals"
+
+
+Time to print the nascent attribute definitions:
+
+  puts Hubbit.print_morph_methods
+
+  # attr_accessor :name
+  # attr_accessor :email
+  # attr_accessor :blog
+  # attr_accessor :company
+  # attr_accessor :location
+  # attr_accessor :projects
+
+
+See examples/ directory for more example code.
+See LICENSE for the terms of this software.
+
+                                                     ,
+                                                 ?7+~::+II~
+                                                ?7:     ,:+7
+                             777IIII777?        7:         :?7
+                          =I=           I:      7?          ,+7
+                         I?         ,,   77      7:           :I
+                        =  ?7777   77  7   7      7+,          :7
+                       7   777777 ~77+=77  I+      I?          ,7
+                      :7  77  ~77  I   I7   7       ?:          ?
+                      I   77   7,  7    7   :I       I          ?
+                      7   ?77=7~    77777    7      ~+          ,+
+                      7~                     7  :I7?~            7
+                      =?                     7 ?I    ~I77=       I=
+                       7    ?          :,   7  I7777,     7       7
+                        ?    777?~~7777+    7              7~      7
+                        ?7    ,777777=,   ,7                7      ,7
+                          7=      ,      =7                 7:      7
+                            +7         :7                    7      ,I
+                             :7        ?~                   7?       7
+                              7         7              ~II7~,        7
+                              7         7  ,  =7777777?+,,,         I=
+                            :7,          ~==,                       7
+                       II~,,                                     77~
+                    ,I?                                      +777
+                   7+,                                 ~7777:
+                 ==                               :77
+               :7:                              ,7I
+             7I                                 7
+            I          ,7,                      7
+          =7          77=7                      7
+        ,7          7I   7                      7
+        I,        I7     7                      7
+       ?,       ,7       7,                     7
+       7       7~        7,                     7
+       7      ,7I        7                      7
+       =+       =7       7                      ~=
+        =7        7,     7                       7
+         ,7,       ~7IIII7+,                     7
+           +:              II                    I
+            ?7              I?                   +~
+              II,           +I                    7
+                ~7          ,I                    7
+                  7=        ~7                    7
+                   ?7,     ~7+                    ?~
+                     ~7777I=                      ,7
+                         7:                        7
+                         I                         7
+                         I          ,:77I          7
+                         I          :7             I
+                         I                         =~
+                         7               ,         ,7
+                         +,         7    :         ,7
+                          +         7    +          7
+                          +         7    +         ,7
+                          7         I    ?         ,7
+                          7         +:   7         ,7
+                          7         =+   7         ,7
+                          7         :I   I         ,7
+                          7         :I   7          7
+                          7         :I   I          7
+                          I,        ,7   I:         7
+                          =+        ,7    ?         7
+                          :?,       ,7    7,        7
+                          I:        ,7    7,        ?
+                         :7         ,7    7,        ,
+                        +I,         :     ?         ,=
+                       +=           ~     =~         7
+                    :II,,           =      I         ?
+                =I=                 ?      7,        :7
+              II~                   I      7,         ,II
+            7~                      ~7     7            ,=7
+            =                       =7     I,             ::
+            77II?==?II777777777777777      7~              7
+                                            77+,,          7:
+                                               777777+:,~777
+

data/examples/forger.rb

@@ -0,0 +1,31 @@
+require 'hpricot'; require 'open-uri'; require 'morph'
+
+# An example of Morph playing with Hpricot
+class Forger
+
+  include Morph
+
+  def initialize name
+    begin
+      doc = Hpricot open("http://rubyforge.org/users/#{name}")
+
+      table = doc.at('td[text() = "Personal Information"]').parent.parent
+      values = table/'tr/td/strong'
+
+      values.collect do |node|
+        value = node.inner_text.strip
+        label = node.at('../../td[1]').inner_text
+        morph(label, value)
+      end
+    rescue
+      raise "Couldn't find forger with name: #{name}"
+    end
+  end
+end
+
+def Forger name
+  Forger.new name
+end
+
+#> why = Forger 'why'
+#> dhh = Forger 'webster123'

data/examples/hubbit.rb

@@ -0,0 +1,30 @@
+require 'hpricot'; require 'open-uri'; require 'morph'
+
+# An example of Morph playing with Hpricot
+class Hubbit
+
+  include Morph
+
+  def initialize name
+    begin
+      doc = Hpricot open("http://github.com/#{name}")
+
+      (doc/'label').collect do |node|
+        label = node.inner_text
+        value = node.next_sibling.inner_text.strip
+
+        morph(label, value) # magic morphing happening here!
+      end
+    rescue
+      raise "Couldn't find hubbit with name: #{name}"
+    end
+  end
+end
+
+def Hubbit name
+  Hubbit.new name
+end
+
+# why = Hubbit 'why'
+# dhh = Hubbit 'dhh'
+

data/lib/morph.rb

@@ -0,0 +1,82 @@
+module Morph
+  VERSION = "0.1.0"
+
+  def self.included(base)
+    base.extend ClassMethods
+    base.send(:include, InstanceMethods)
+  end
+
+  module ClassMethods
+
+    @@morph_methods = {}
+
+    def convert_to_morph_method_name label
+      name = label.downcase.tr('()*',' ').gsub('%','percentage').strip.chomp(':').strip.gsub(/\s/,'_').squeeze('_')
+      name = '_'+name if name =~ /^\d/
+      name
+    end
+
+    def morph_accessor symbol
+      attribute = symbol.to_s
+      @@morph_methods[attribute] = true
+      @@morph_methods[attribute+'='] = true
+      class_eval "attr_accessor :#{attribute}"
+    end
+
+    def morph_methods
+      @@morph_methods.keys.sort
+    end
+
+    def remove_method symbol
+      @@morph_methods.delete symbol.to_s
+      super
+    end
+
+    def remove_morph_writers
+      writers = morph_methods.select { |m| m =~ /=\Z/ }
+      writers.each do |writer|
+        class_eval "remove_method :#{writer}"
+      end
+    end
+
+    def print_morph_methods
+      methods = morph_methods
+      writers = methods.select { |m| m =~ /=\Z/ }
+      readers = methods.reject { |m| m =~ /=\Z/ }
+
+      accessors = readers.select { |m| writers.include? "#{m}=" }
+      readers =   readers.reject { |m| accessors.include? m }
+      writers =   writers.reject { |m| accessors.include? m.chomp('=') }
+
+      attributes = accessors.collect { |attribute| "attr_accessor :#{attribute}\n" }
+      attributes += readers.collect {  |attribute| "attr_reader :#{attribute}\n" }
+      attributes += writers.collect {  |attribute| "attr_writer :#{attribute}\n" }
+
+      attributes.join.chop
+    end
+  end
+
+  module InstanceMethods
+
+    def morph label, value
+      attribute = self.class.convert_to_morph_method_name label
+      send("#{attribute}=".to_sym, value)
+    end
+
+    def method_missing symbol, *args
+      attribute = symbol.to_s.chomp '='
+      if Object.instance_methods.include?(attribute)
+        raise "'#{attribute}' is an instance_method on Object, cannot create accessor methods for '#{attribute}'"
+      else
+        is_writer = symbol.to_s =~ /=\Z/
+        if is_writer
+          value = args[0]
+          empty_value = (value.nil? or (value.is_a?(String) && value.strip.size == 0))
+          return if empty_value
+        end
+        self.class.morph_accessor attribute.to_sym
+        send(symbol, *args)
+      end
+    end
+  end
+end

data/morph.gemspec

@@ -0,0 +1,56 @@
+
+# Gem::Specification for Morph-0.1.0
+# Originally generated by Echoe
+
+Gem::Specification.new do |s|
+  s.name = %q{morph}
+  s.version = "0.1.0"
+
+  s.specification_version = 2 if s.respond_to? :specification_version=
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Rob McKinnon"]
+  s.date = %q{2008-03-24}
+  s.description = %q{Morph allows you to emerge class definitions via calling assignment methods.}
+  s.email = ["rob ~@nospam@~ rubyforge.org"]
+  s.files = ["CHANGELOG", "examples/forger.rb", "examples/hubbit.rb", "lib/morph.rb", "LICENSE", "README", "spec/morph_spec.rb", "spec/spec.opts", "Manifest", "morph.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{}
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{morph}
+  s.rubygems_version = %q{1.0.1}
+  s.summary = %q{Morph allows you to emerge class definitions via calling assignment methods.}
+end
+
+
+# # Original Rakefile source (requires the Echoe gem):
+# 
+# require 'rubygems'
+# require 'spec'
+# require 'lib/morph'
+# 
+# begin
+#   require 'echoe'
+# 
+#   Echoe.new("morph", Morph::VERSION) do |morph|
+#     morph.author = ["Rob McKinnon"]
+#     morph.email = ["rob ~@nospam@~ rubyforge.org"]
+#     morph.description = File.readlines("README").first
+#     morph.rubyforge_name = "morph"
+#   end
+# 
+# rescue LoadError
+#   puts "You need to install the echoe gem to perform meta operations on this gem"
+# end
+# 
+# desc "Open an irb session preloaded with this library"
+# task :console do
+#   sh "irb -rubygems -r ./lib/morph.rb"
+# end
+# 
+# desc "Run spec runner"
+# task(:test) do
+#   files = FileList['spec/**/*_spec.rb']
+#   Spec::Runner::CommandLine.run(rspec_options)
+#   system "ruby spec/spec_runner.rb #{files} --format specdoc"
+# end

data/spec/morph_spec.rb

@@ -0,0 +1,308 @@
+$KCODE = "u"
+
+require File.dirname(__FILE__) + '/../lib/morph'
+
+module MorphSpecHelperMethods
+
+  def initialize_morph_class
+    @morphed_class = eval 'class ExampleMorph; include Morph; end'
+  end
+
+  def initialize_morph
+    initialize_morph_class
+    @original_instance_methods = @morphed_class.instance_methods
+    @morph = @morphed_class.new
+  end
+
+  def remove_morph_methods
+    @morphed_class.instance_methods.each do |method|
+      @morphed_class.class_eval "remove_method :#{method}" unless @original_instance_methods.include?(method)
+    end
+  end
+
+  def instance_methods
+    @morphed_class.instance_methods
+  end
+
+  def morph_methods
+    @morphed_class.morph_methods
+  end
+
+  def check_convert_to_morph_method_name label, method_name
+    initialize_morph_class
+    @morphed_class.convert_to_morph_method_name(label).should == method_name
+  end
+end
+
+describe "class with generated accessor methods added", :shared => true do
+
+  include MorphSpecHelperMethods
+  before :all do initialize_morph; end
+  after  :all do remove_morph_methods; end
+
+  it 'should add reader method to class instance_methods list' do
+    instance_methods.include?(@attribute).should == true
+  end
+
+  it 'should add writer method to class instance_methods list' do
+    instance_methods.include?("#{@attribute}=").should == true
+  end
+
+  it 'should add reader method to class morph_methods list' do
+    morph_methods.include?(@attribute).should == true
+  end
+
+  it 'should add writer method to class morph_methods list' do
+    morph_methods.include?("#{@attribute}=").should == true
+  end
+
+  it 'should only have generated accessor methods in morph_methods list' do
+    morph_methods.size.should == @expected_morph_methods_count
+  end
+
+  it 'should be able to print morph method declarations' do
+    @morphed_class.print_morph_methods.should == %Q|attr_accessor :#{@attribute}|
+  end
+end
+
+describe "class without generated accessor methods added", :shared => true do
+  include MorphSpecHelperMethods
+
+  before :all do
+    initialize_morph
+  end
+
+  after :all do
+    remove_morph_methods
+  end
+
+  it 'should not add reader method to class instance_methods list' do
+    instance_methods.include?(@attribute).should == false
+  end
+
+  it 'should not add writer method to class instance_methods list' do
+    instance_methods.include?("#{@attribute}=").should == false
+  end
+
+  it 'should not add reader method to class morph_methods list' do
+    morph_methods.include?(@attribute).should == false
+  end
+
+  it 'should not add writer method to class morph_methods list' do
+    morph_methods.include?("#{@attribute}=").should == false
+  end
+
+  it 'should have empty morph_methods list' do
+    morph_methods.size.should == 0
+  end
+end
+
+describe Morph, "when reader method that didn't exist before is called" do
+  before :each do
+    remove_morph_methods
+    @morph.noise
+    @attribute = 'noise'
+    @expected_morph_methods_count = 2
+  end
+
+  it_should_behave_like "class with generated accessor methods added"
+
+  it 'should return nil if reader is called' do
+    @morph.noise.should == nil
+  end
+end
+
+describe Morph, "when writer method that didn't exist before is called with non-nil value" do
+  before :each do
+    remove_morph_methods
+    @quack = 'quack'
+    @morph.noise= @quack
+    @attribute = 'noise'
+    @expected_morph_methods_count = 2
+  end
+
+  it_should_behave_like "class with generated accessor methods added"
+
+  it 'should return assigned value when reader method called' do
+    @morph.noise.should == @quack
+  end
+end
+
+describe Morph, "when writer method that didn't exist before is in unicode" do
+  before :each do
+    remove_morph_methods
+    @age = 19
+    @attribute = "年龄"
+    @morph.morph(@attribute, @age)
+    @expected_morph_methods_count = 2
+  end
+
+  it_should_behave_like "class with generated accessor methods added"
+
+  it 'should return assigned value when reader method called' do
+    @morph.send(@attribute.to_sym) == @age
+  end
+end
+
+describe Morph, "when writer method that didn't exist before is called with nil value" do
+  before :each do
+    remove_morph_methods
+    @morph.morph('Pizza', nil)
+    @attribute = 'pizza'
+  end
+
+  it_should_behave_like "class without generated accessor methods added"
+end
+
+describe Morph, 'when morph method used to set blank space attribute value' do
+  before :each do
+    remove_morph_methods
+    @morph.morph('Pizza', '   ')
+    @attribute = 'pizza'
+  end
+
+  it_should_behave_like "class without generated accessor methods added"
+end
+
+describe Morph, 'when morph method used to set nil attribute value' do
+  before :each do
+    remove_morph_methods
+    @morph.morph('Pizza', nil)
+    @attribute = 'pizza'
+  end
+
+  it_should_behave_like "class without generated accessor methods added"
+end
+
+
+describe Morph, 'when remove_morph_writers is called after a generated method has been added' do
+
+  include MorphSpecHelperMethods
+  before :all do initialize_morph; end
+  after  :all do remove_morph_methods; end
+
+  before :each do
+    remove_morph_methods
+    @morph.noise= 'quack'
+    @attribute = 'noise'
+    @morphed_class.remove_morph_writers
+  end
+
+  it 'should remove a morph generated writer method from morph_methods list' do
+    morph_methods.include?('noise=').should == false
+    morph_methods.size.should == 1
+  end
+
+  it 'should remove a morph generated writer method from class instance_methods list' do
+    instance_methods.include?('noise=').should == false
+  end
+
+  it 'should be able to print morph method declarations' do
+    @morphed_class.print_morph_methods.should == %Q|attr_reader :#{@attribute}|
+  end
+
+end
+
+describe Morph, "when reader method called is a class method" do
+
+  before :each do
+    remove_morph_methods
+    @morph.name
+    @attribute = 'name'
+    @expected_morph_methods_count = 2
+  end
+
+  it_should_behave_like "class with generated accessor methods added"
+end
+
+describe Morph, "when writer method called is a class method" do
+
+  before :each do
+    remove_morph_methods
+    @value = 'Morph'
+    @morph.name = @value
+    @attribute = 'name'
+    @expected_morph_methods_count = 2
+  end
+
+  it_should_behave_like "class with generated accessor methods added"
+
+  it 'should return assigned value when reader method called' do
+    @morph.name.should == @value
+  end
+end
+
+describe Morph, "when class= is called" do
+
+  include MorphSpecHelperMethods
+  before :all do initialize_morph; end
+  after  :all do remove_morph_methods; end
+
+  it 'should throw exception if non nil object is passed' do
+    lambda { @morph.class = 'Red' }.should raise_error(/cannot create accessor methods/)
+  end
+
+  it 'should throw exception if nil object is passed' do
+    lambda { @morph.class = nil }.should raise_error(/cannot create accessor methods/)
+  end
+end
+
+describe Morph, "when converting label text to morph method name" do
+
+  include MorphSpecHelperMethods
+
+  it 'should upper case to lower case' do
+    check_convert_to_morph_method_name 'CaSe', 'case'
+  end
+  it 'should convert single space to underscorce' do
+    check_convert_to_morph_method_name 'First reading', 'first_reading'
+  end
+  it 'should convert multiple spaces to single underscorce' do
+    check_convert_to_morph_method_name "First  reading", 'first_reading'
+  end
+  it 'should convert tabs to single underscorce' do
+    check_convert_to_morph_method_name "First\t\treading", 'first_reading'
+  end
+  it 'should convert new line chars to single underscorce' do
+    check_convert_to_morph_method_name "First\r\nreading", 'first_reading'
+  end
+  it 'should remove leading and trailing whitespace new line chars to single underscorce' do
+    check_convert_to_morph_method_name " \t\r\nFirst reading \t\r\n", 'first_reading'
+  end
+  it 'should remove trailing colon surrounded by whitespace' do
+    check_convert_to_morph_method_name "First reading : ", 'first_reading'
+  end
+  it 'should remove parenthesis' do
+    check_convert_to_morph_method_name 'Nav(GBX)', 'nav_gbx'
+  end
+  it 'should remove *' do
+    check_convert_to_morph_method_name 'Change**', 'change'
+  end
+  it 'should convert % character to the text "percentage"' do
+    check_convert_to_morph_method_name '% Change', 'percentage_change'
+  end
+  it 'should precede leading digit with an underscore character' do
+    check_convert_to_morph_method_name '52w_high', '_52w_high'
+  end
+  it 'should handle unicode name' do
+    check_convert_to_morph_method_name '年龄', '年龄'
+  end
+end
+
+describe Morph, 'when morph method used to set attribute value and attribute name ends with colon' do
+
+  before :each do
+    remove_morph_methods
+    @value = '20 Mar 2008'
+    @morph.morph('First reading : ', @value)
+    @attribute = 'first_reading'
+    @expected_morph_methods_count = 2
+  end
+
+  it_should_behave_like "class with generated accessor methods added"
+
+  it 'should return assigned value when reader method called' do
+    @morph.first_reading.should == @value
+  end
+end
+

data/spec/spec.opts

@@ -0,0 +1,7 @@
+--colour
+--format
+progress
+--loadby
+mtime
+--reverse
+--backtrace

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: morph
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Rob McKinnon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-03-24 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: Morph allows you to emerge class definitions via calling assignment methods.
+email: 
+- rob ~@nospam@~ rubyforge.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- CHANGELOG
+- examples/forger.rb
+- examples/hubbit.rb
+- lib/morph.rb
+- LICENSE
+- README
+- spec/morph_spec.rb
+- spec/spec.opts
+- Manifest
+- morph.gemspec
+has_rdoc: true
+homepage: ""
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: morph
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Morph allows you to emerge class definitions via calling assignment methods.
+test_files: []
+