craft 0.0.2 → 0.1.0

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - rbx-19mode
+  - jruby-19mode

data/CHANGES.md

@@ -0,0 +1,8 @@
+v0.1.0
+-----------
+
+- When nesting, make parent accessible to child.
+- Craft#attributes returns the attributes.
+- Craft.stub stubs a static or dynamic value that doesn't need to be parsed in
+  the document.
+- Transforms are executed in the context of the crafted object.

data/Gemfile

@@ -2,3 +2,12 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in craft.gemspec
 gemspec
+
+group :ci do
+  gem 'rake'
+end
+
+platforms :jruby do
+  gem 'minitest'
+end
+gem 'pry'

data/README.md

@@ -1,4 +1,4 @@
-# Craft
+# Craft [![Build Status](https://secure.travis-ci.org/papercavalier/craft.png)](http://travis-ci.org/papercavalier/craft)
 
 Craft XML and HTML into objects.
 
@@ -16,6 +16,9 @@ class Page < Craft
 
   # Perform transforms on returned nodes
   many  :images,  'img', lambda { |img| img.attr('src').upcase }
+
+  # Stub attributes that don't need to be parsed
+  stub :spidered_at, lambda { Time.now }
 end
 
 page = Page.parse open('http://www.google.com')
@@ -24,6 +27,8 @@ page.title #=> 'Google'
 page.links #=> ['http://www.google.com/imghp?hl=en&tab=wi', ...]
 page.images #=> ['/LOGOS/2012/MOBY_DICK12-HP.JPG']
 
+page.attributes #=> { :title => 'Google', :links => ... }
+
 class Script < Craft
   one :body, 'text()'
 end

data/lib/craft.rb

@@ -7,6 +7,7 @@ require 'nokogiri'
 #
 #   module Transformations
 #     IntegerTransform = lambda { |n| Integer n.text }
+#     Timestamp        = lambda { Time.now }
 #   end
 #
 #   class Person < Craft
@@ -15,46 +16,48 @@ require 'nokogiri'
 #     one :name, 'div.name'
 #     one :age, 'div.age', IntegerTransform
 #     many :friends, 'li.friend', Person
+#     stub :created_at, Timestamp
 #   end
 #
 class Craft
   class << self
-    # We alias call to new so that crafted objects may nest themselves or other
-    # crafted objects as transformations.
-    alias call new
+    # Returns an Array of names for the attributes defined in the class.
+    attr :attribute_names
 
-    # Define a method that extracts a collection of values from a parsed
+    # Define an attribute that extracts a collection of values from a parsed
     # document.
     #
-    # name  - The Symbol name of the method.
+    # name  - The Symbol name of the attribute.
     # paths - One or more String XPath of CSS queries. An optional Proc
     #         transformation on the extracted value may be appended. If none is
     #         appended, the default transformation returns the stripped String
     #         value of the node.
     #
-    # Returns an Array.
+    # Returns nothing.
     def many(name, *paths)
-      transform = pop_transformation paths
+      transform = pop_transform_from_paths paths
+      @attribute_names << name
 
       define_method name do
-        @node.search(*paths).map { |node| transform.call node }
+        @node.search(*paths).map { |node| instance_exec node, &transform }
       end
     end
 
-    # Define a method that extracts a single value from a parsed document.
+    # Define an attribute that extracts a single value from a parsed document.
     #
-    # name  - The Symbol name of the method.
+    # name  - The Symbol name of the attribute.
     # paths - One or more String XPath of CSS queries. An optional Proc
     #         transformation on the extracted value may be appended. If none is
     #         appended, the default transformation returns the stripped String
     #         value of the node.
     #
-    # Returns an Object.
+    # Returns nothing.
     def one(name, *paths)
-      transform = pop_transformation paths
+      transform = pop_transform_from_paths paths
+      @attribute_names << name
 
       define_method name do
-        transform.call @node.at(*paths)
+        instance_exec @node.at(*paths), &transform
       end
     end
 
@@ -67,25 +70,58 @@ class Craft
       new Nokogiri body
     end
 
+    # Define an attribute that returns a value without parsing the document.
+    #
+    # name  - The Symbol name of the attribute.
+    # value - Some value the attribute should return. If given a Proc, the
+    #         value will be generated dynamically (default: nil).
+    #
+    # Returns nothing.
+    def stub(name, value = nil)
+      @attribute_names << name
+
+      define_method name do
+        value.respond_to?(:call) ? instance_exec(&value) : value
+      end
+    end
+
+    def to_proc
+      klass = self
+      ->(node) { klass.new node, self }
+    end
+
     private
 
-    def pop_transformation(array)
-      if array.last.respond_to? :call
+    def inherited(subclass)
+      subclass.instance_variable_set :@attribute_names, []
+    end
+
+    def pop_transform_from_paths(array)
+      if array.last.respond_to? :to_proc
         array.pop
       else
-        Module.new do
-          def self.call(node)
-            node.text.strip if node
-          end
-        end
+        ->(node) { node.text.strip if node }
       end
     end
   end
 
+  attr :parent
+
   # Craft a new object.
   #
   # node - A Nokogiri::XML::Node.
-  def initialize(node)
+  def initialize(node, parent = nil)
     @node = node
+    @parent = parent
+  end
+
+  # Returns the Hash attributes.
+  def attributes
+    Hash[attribute_names.map { |key| [key, self.send(key)] }]
+  end
+
+  # Returns an Array of names for the attributes on this object.
+  def attribute_names
+    self.class.attribute_names
   end
 end

data/lib/craft/version.rb

@@ -1,3 +1,3 @@
 class Craft
-  VERSION = '0.0.2'
+  VERSION = '0.1.0'
 end

data/spec/craft_spec.rb

@@ -3,45 +3,89 @@ require 'minitest/autorun'
 require 'craft'
 
 describe Craft do
-  let :html do
-    '<html><ul><li>1</li><li>2</li>'
-  end
+  let(:html) { '<html><ul><li>1</li><li>2</li>' }
+  let(:klass) { Class.new Craft }
+  let(:instance) { klass.parse html }
 
-  let :klass do
-    Class.new Craft
-  end
+  describe '.attribute_names' do
+    it 'is empty by default' do
+      klass.attribute_names.must_equal []
+    end
 
-  let :instance do
-    klass.parse html
+    it 'does not reference other attribute names' do
+      klass.stub :foo
+      other = Class.new(Craft) { stub :bar }
+      klass.attribute_names.wont_equal other.attribute_names
+    end
   end
 
   describe '.many' do
     it 'extracts nodes' do
-      klass.many 'foo', 'li'
+      klass.many :foo, 'li'
       instance.foo.must_equal %w(1 2)
     end
 
     it 'transforms' do
-      klass.many 'foo', 'li', ->(node) { node.text.to_i }
+      klass.many :foo, 'li', ->(node) { node.text.to_i }
       instance.foo.must_equal [1, 2]
     end
+
+    it 'transforms in scope' do
+      klass.many :foo, 'li', ->(node) { bar }
+      klass.send(:define_method, :bar) { 'bar' }
+      instance.foo.must_equal ['bar', 'bar']
+    end
+
+    it 'stores attribute name' do
+      klass.many :foo, 'li'
+      klass.attribute_names.must_include :foo
+    end
+
+    it 'nests' do
+      klass.many :foo, 'ul', Class.new(Craft)
+      instance.foo.each { |attr| attr.must_be_kind_of Craft }
+    end
+
+    it 'has a parent when nested' do
+      klass.many :foo, 'li', Class.new(Craft)
+      instance.foo.each { |attr| attr.parent.must_equal instance }
+    end
   end
 
   describe '.one' do
     it 'extracts a node' do
-      klass.one 'foo', 'li'
+      klass.one :foo, 'li'
       instance.foo.must_equal '1'
     end
 
     it 'transforms' do
-      klass.one 'foo', 'li', ->(node) { node.text.to_i }
+      klass.one :foo, 'li', ->(node) { node.text.to_i }
       instance.foo.must_equal 1
     end
 
+    it 'transforms in scope' do
+      klass.one :foo, 'li', ->(node) { bar }
+      klass.send(:define_method, :bar) { 'bar' }
+      instance.foo.must_equal 'bar'
+    end
+
+    it 'stores attribute name' do
+      klass.one :foo, 'li'
+      klass.attribute_names.must_include :foo
+    end
+
+    it 'nests' do
+      klass.one :foo, 'ul', Class.new(Craft)
+      instance.foo.must_be_kind_of Craft
+    end
+
+    it 'has a parent when nested' do
+      klass.one :foo, 'li', Class.new(Craft)
+      instance.foo.parent.must_equal instance
+    end
+
     describe 'given no matches' do
-      before do
-        klass.one 'foo', 'foo'
-      end
+      before { klass.one :foo, 'bar' }
 
       it 'returns nil' do
         instance.foo.must_be_nil
@@ -49,10 +93,39 @@ describe Craft do
     end
   end
 
-  it 'nests' do
-    nest = Class.new Craft
-    nest.many 'foo', 'li'
-    klass.one 'foo', 'ul', nest
-    instance.foo.foo.must_equal %w(1 2)
+  describe '.stub' do
+    it 'returns nil by default' do
+      klass.stub :foo
+      instance.foo.must_be_nil
+    end
+
+    it 'returns a static value' do
+      klass.stub :foo, 1
+      instance.foo.must_equal 1
+    end
+
+    it 'returns a dynamic value' do
+      klass.stub :foo, -> { Time.now }
+      instance.foo.must_be_instance_of Time
+    end
+
+    it 'transforms in scope' do
+      klass.stub :foo, -> { bar }
+      klass.send(:define_method, :bar) { 'bar' }
+      instance.foo.must_equal 'bar'
+    end
+
+    it 'stores attribute name' do
+      klass.stub :foo
+      klass.attribute_names.must_include :foo
+    end
+  end
+
+  describe '#attributes' do
+    it 'returns attributes' do
+      klass.stub :foo
+      klass.one  :bar, 'li'
+      instance.attributes.must_equal({ foo: nil, bar: '1' })
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: craft
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-18 00:00:00.000000000 Z
+date: 2012-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -36,6 +36,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
+- CHANGES.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -58,7 +60,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3848600058118697198
+      hash: 2821744877133646519
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -67,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3848600058118697198
+      hash: 2821744877133646519
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23