benschwarz-smoke 0.3.7 → 0.3.9

data/README.markdown

@@ -83,6 +83,14 @@ Integrity [is running for smoke](http://integrity.ffolio.net/smoke)
 #### For wiki pages (docs, later)
 * How to use `path`
 * YQL Definitions
+* Tranformations
+* Insert
+* Joining
+* Variable injection
+* Sort, Reverse
+* Keep, Discard
+* Truncate
+
 
 ### Copyright
 

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 7
+:patch: 9
 :major: 0
 :minor: 3

data/lib/smoke/origin.rb

@@ -71,27 +71,50 @@ module Smoke
     #     rename(:href => :link)
     #   end 
     def emit(&block)
+      raise ArgumentError, "requires a block" unless block_given?
       @transformation << block
     end
     
     # Transform must be used inside an `emit` block.
-    # It can be used to alter the a single field at a time
+    # It can be used to alter named keys within the item set
     #
     # Usage:
     #     emit do
-    #       transform :name do |name|
+    #       transform :name, :description do |name|
     #         name.gsub(/\302/, "")
     #       end
     #     end
     #
     # In quasi-english: The result of the block is returned and set to each 
-    # of the :name attributes in the result set.
-    def transform(name, &block)
-      items.each do |item|
-        item[name] = yield(item[name]) || item[name]
+    # of the :name and :description keys in the result set.
+    def transform(*keys)
+      raise ArgumentError, "requires a block" unless block_given?
+      keys.each do |key|
+        items.each do |item|
+          item[key] = yield(item[key]) || item[key]
+        end
       end
     end
     
+    # Insert must be used inside an `emit` block.
+    # It can be used to insert named keys to all items within the result set
+    # 
+    # Usage: 
+    #   
+    #   emit do
+    #     insert :source, "twitter"
+    #   end
+    # 
+    # Once output is called, all items will contain a key of :source with
+    # a value of "twitter"
+    def insert(key, value)
+      @items.each do |item|
+        item[key] = value
+      end
+      
+      return self
+    end
+
     # Prepare is used when you'd like to provision for 
     # arguments / variables to be set after the source definition.
     # Eg, create a source definition for twitter, omitting the "username".

data/lib/smoke.rb

@@ -5,11 +5,6 @@ require 'crack'
 require 'simple-rss'
 require 'json'
 
-$:<< File.join(File.dirname(__FILE__))
-
-# Core ext
-require 'core_ext/hash.rb'
-
 module Smoke  
   class << self
     @@active_sources = {}
@@ -96,8 +91,7 @@ module Smoke
   end
 end
 
-require 'smoke/request'
-require 'smoke/origin'
+%w(core_ext/hash smoke/request smoke/origin).each {|r| require File.join(File.dirname(__FILE__), r)}
 
 class Object # :nodoc: 
   include Smoke

data/spec/smoke/origin_spec.rb

@@ -7,7 +7,7 @@ describe Smoke::Origin do
         rename(:head => :title)
         sort(:title)
         
-        transform :title do |title|
+        transform :title, :name do |title|
           title.gsub(/Animal: /, '')
         end
       end
@@ -24,7 +24,7 @@ describe Smoke::Origin do
     end
     
     it "should output a single hash rather than a hash in an array when there is one item" do
-      Smoke[:test].truncate(1).output.should == {:title => "Kangaroo"}
+      Smoke[:test].truncate(1).output.should == {:title => "Kangaroo", :name => "Kelly"}
     end
   end
   
@@ -38,11 +38,11 @@ describe Smoke::Origin do
     end
     
     it "should reverse the results" do
-      Smoke[:test].sort(:header).reverse.output.should == [{:header => "Platypus"}, {:header => "Kangaroo"}]
+      Smoke[:test].sort(:header).reverse.output.should == [{:header => "Platypus", :name => "Peter"}, {:header => "Kangaroo", :name => "Kelly"}]
     end
     
     it "should truncate results given a length" do
-      Smoke[:test].truncate(1).output.size.should == 1
+      Smoke[:test].truncate(1).output.should be_an_instance_of(Hash)
     end
     
     describe "filtering" do
@@ -69,7 +69,7 @@ describe Smoke::Origin do
       end
       
       it "should only contain items that match" do
-        Smoke[:keep].keep(:head, /^K/).output.should == {:head => "Kangaroo"}
+        Smoke[:keep].keep(:head, /^K/).output.should == {:head => "Kangaroo", :name => "Kelly"}
       end
       
       it "should discard items" do
@@ -77,7 +77,7 @@ describe Smoke::Origin do
       end
       
       it "should not contain items that match" do
-        Smoke[:discard].discard(:head, /^K/).output.should == {:head => "Platypus"}
+        Smoke[:discard].discard(:head, /^K/).output.should == {:head => "Platypus", :name => "Peter"}
       end
     end
   end
@@ -96,7 +96,7 @@ describe Smoke::Origin do
     end
 
     it "should output yml" do
-      @origin.output(:yaml).should =~ /--- \n- :title:/
+      @origin.output(:yaml).should =~ /^--- \n- :/
     end
     
     it "should dispatch when output is called" do
@@ -117,7 +117,7 @@ describe Smoke::Origin do
         end
       end
     end
-    Smoke[:chain].rename(:head => :header).sort(:header).output.should == [{:header => "Kangaroo"}, {:header => "Platypus"}]
+    Smoke[:chain].rename(:head => :header).sort(:header).output.should == [{:header => "Kangaroo", :name => "Kelly"}, {:header => "Platypus", :name => "Peter"}]
   end
   
   it "should softly error when attempting to sort on a key that doesn't exist" do
@@ -190,12 +190,33 @@ describe Smoke::Origin do
       Smoke[:test].should respond_to(:emit)
     end
     
+    it "emit should require a block" do
+      lambda { Smoke[:test].emit }.should raise_error
+      lambda { Smoke[:test].emit {} }.should_not raise_error
+    end
+    
     it "should respond to transform" do
       Smoke[:test].should respond_to(:transform)
     end
     
+    it "tranform should require a block" do
+      lambda { Smoke[:test].transform }.should raise_error
+      lambda { Smoke[:test].transform {} }.should_not raise_error
+    end
+    
     it "should have at least one transformation" do
-      Smoke[:test].transformation.size.should == 1
+      Smoke[:test].transformation.size.should_not be_nil
+    end
+  end
+  
+  describe "key insertion" do
+    it "should respond to insert" do
+      Smoke[:test].should respond_to(:insert)
+    end
+    
+    it "should insert values into each key" do
+      Smoke[:test].insert(:source, "twitter").output.first.should have_key :source
+      Smoke[:test].insert(:source, "twitter").output.first[:source].should == "twitter"
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,17 +1,12 @@
 require 'rubygems'
-gem 'rspec'
-
 require 'spec'
 require 'fake_web'
 
-$:<< File.join(File.dirname(__FILE__), '..', 'lib')
-
+require File.join(File.dirname(__FILE__), '..', 'lib', 'smoke')
 
 SPEC_DIR = File.dirname(__FILE__) unless defined? SPEC_DIR
 $:<< SPEC_DIR
 
-require 'smoke'
-
 require 'supports/mayo.rb'
 require 'supports/test_source.rb'
 

data/spec/supports/test_source.rb

@@ -1,9 +1,9 @@
 module TestSource
   def self.source(name, &block)
-    source = Smoke::Origin.new(name, &block || Proc.new {})
+    source = Smoke::Origin.new(name, &block)
     source.items = [
-      {:head => "Animal: Platypus"},
-      {:head => "Animal: Kangaroo"}
+      {:head => "Animal: Platypus", :name => "Peter"},
+      {:head => "Animal: Kangaroo", :name => "Kelly"}
     ]
     return source
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: benschwarz-smoke
 version: !ruby/object:Gem::Version 
-  version: 0.3.7
+  version: 0.3.9
 platform: ruby
 authors: 
 - Ben Schwarz
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-15 00:00:00 -07:00
+date: 2009-06-18 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -100,7 +100,7 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.2.0
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: smoke is a DSL that allows you to take data from YQL, RSS / Atom
 test_files: []