benschwarz-smoke 0.3.4 → 0.3.5

data/README.markdown

@@ -48,7 +48,21 @@ or even
         rename :shit_name => :title
       end
     end
+    
+### Define a source allowing for variables to be injected later
 
+Source definition:
+
+    Smoke.feed :delicious do
+      prepare do
+        url "http://feeds.delicious.com/v2/rss/#{username}?count=15"
+      end
+    end
+
+Execution: 
+
+    Smoke[:delicious].username("bschwarz").output
+    
 ### CI
 
 Integrity [is running for smoke](http://integrity.ffolio.net/smoke)
@@ -56,8 +70,6 @@ Integrity [is running for smoke](http://integrity.ffolio.net/smoke)
 
 ### TODO (working on, just mental notes)
 
-* Joined sources require a call to dispatch when their parent calls output
-* Sources that are renamed also need their @name's renaming
 * Implement a disaptch / request method that will actually thread property (event-machine)
 * Checkout experimental fakeweb version to stub out the yql specs
 

data/VERSION.yml

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

data/lib/smoke.rb

@@ -27,16 +27,6 @@ module Smoke
       active_sources[source]
     end
     
-    def join(*sources, &block)
-      @items = get_sources(sources).map {|source| source[1].items }.flatten
-      
-      joined_name = (sources << "joined").join("_").to_sym
-      source = Origin.new(joined_name, &block)
-
-      source.items = @items
-      return source
-    end
-    
     # Activates new instances of sources
     # Source instances are stored within the 
     # @@active_sources class variable for later use
@@ -55,6 +45,7 @@ module Smoke
     # Rename a source 
     def rename(candidates)
       candidates.each do |o, n| 
+        active_sources[o].name = n.to_s
         active_sources.rename(o => n)
         return active_sources[n]
       end
@@ -74,10 +65,13 @@ module Smoke
     def data(name, &block); Smoke::Source::Data.new(name, &block); end
     def feed(name, &block); Smoke::Source::Feed.new(name, &block); end
     
-    private
-    def get_sources(sources = [])
-      active_sources.find_all{|k, v| sources.include?(k) }
-    end
+    # Join multiple sources together into a single feed
+    # Usage:
+    #   Smoke.join(:delicious, :twitter, :flickr) do
+    #     name :stream
+    #     path :photos, :photo
+    #   end
+    def join(*names, &block); Smoke::Source::Join.new(names, &block); end
   end
 end
 

data/lib/smoke/origin.rb

@@ -1,6 +1,7 @@
 module Smoke
   class Origin
-    attr_reader :items, :name
+    attr_reader :items
+    attr_accessor :name
     
     def initialize(name, &block)
       raise StandardError, "Sources must have a name" unless name
@@ -182,7 +183,7 @@ module Smoke
     end
     
     def activate!
-      Smoke.activate(name, self)
+      Smoke.activate(@name, self)
     end
   end
 end

data/lib/smoke/source/join.rb

@@ -0,0 +1,34 @@
+module Smoke
+  module Source # :nodoc:
+    # The "Joiner" source is a special source
+    # that can be used to join multiple sources together
+    # and proxy call dispatch for each source
+    #
+    # Usage:
+    #   Smoke.join(:delicious, :twitter, :flickr) do
+    #     name :stream
+    #     path :photos, :photo
+    #   end
+    class Join < Origin # :nodoc: 
+      def initialize(names, &block)
+        @names = names
+        super((names << "joined").join("_").to_sym, &block)
+      end
+      
+      protected
+      def sources
+        Smoke.active_sources.find_all{|k, v| @names.include?(k) }
+      end
+      
+      def dispatch
+        # Recall dispatch
+        sources.each do |source|
+          source.last.send(:dispatch) if source.last.respond_to?(:dispatch)
+        end
+        
+        # Re-map items
+        @items = sources.map {|source| source.last.items }.flatten
+      end
+    end
+  end
+end

data/spec/smoke/source/join_spec.rb

@@ -0,0 +1,66 @@
+require File.join(File.dirname(__FILE__), "..", "..", "spec_helper.rb")
+
+describe "Join" do
+  before :all do
+    @source_a = TestSource.source :a
+    @source_b = TestSource.source :b
+    @source_c = TestSource.source :c
+  end
+  
+  describe "joining" do
+    before do
+      @joined = Smoke.join(:a, :b)
+    end
+    
+    it "should be named in a_b_joined" do
+      Smoke[:a_b_joined].should be_an_instance_of(Smoke::Source::Join)
+    end
+    
+    it "should contain items from sources a and b" do
+      Smoke[:a_b_joined].output.size.should == (@source_a.output.size + @source_b.output.size)
+    end
+    
+    it "should accept a block" do
+      lambda { Smoke.join(:a, :b, :c, Proc.new {}) }.should_not raise_error
+    end
+    
+    it "should allow sorting" do
+      Smoke[:a_b_joined].should respond_to(:sort)
+    end
+    
+    it "should allow changes to output" do
+      Smoke[:a_b_joined].should respond_to(:output)
+    end
+        
+    describe "renaming" do
+      it "should allow renaming" do
+        Smoke[:a_b_joined].should respond_to(:rename)
+      end
+      
+      it "should be renamed" do
+        Smoke.rename(:a_b_joined => :rename_spec)
+        Smoke[:rename_spec].should be_an_instance_of(Smoke::Source::Join)
+      end
+      
+      it "should change its name property after being renamed" do
+        Smoke[:rename_spec].name.should == "rename_spec"
+      end
+    end
+    
+    describe "dispatching" do
+      before :all do
+        FakeWeb.register_uri("http://photos.tld", :response => File.join(SPEC_DIR, 'supports', 'flickr-photo.json'))
+
+        Smoke.data(:should_dispatch) do
+          url "http://photos.tld"
+          path :photos, :photo
+        end
+      end
+      
+      it "should call dispatch for its children" do
+        Smoke[:should_dispatch].should_receive(:dispatch)
+        Smoke.join(:a, :should_dispatch).output
+      end
+    end
+  end
+end

data/spec/smoke_spec.rb

@@ -1,36 +1,9 @@
 require File.join(File.dirname(__FILE__), "spec_helper.rb")
 
 describe Smoke do
-  before do
+  before :all do
     @source_a = TestSource.source :a
     @source_b = TestSource.source :b
-    @source_c = TestSource.source :c
-  end
-  
-  describe "joining" do
-    before do
-      @joined = Smoke.join(:a, :b)
-    end
-    
-    it "should contain items from sources a and b" do
-      @joined.output.size.should == (@source_a.output.size + @source_b.output.size)
-    end
-    
-    it "should accept a block" do
-      lambda { Smoke.join(:a, :b, Proc.new {}) }.should_not raise_error
-    end
-    
-    it "should allow sorting" do
-      Smoke.join(:a, :b).should respond_to(:sort)
-    end
-    
-    it "should allow renaming" do
-      Smoke.join(:a, :b).should respond_to(:rename)
-    end
-    
-    it "should allow changes to output" do
-      Smoke.join(:a, :b).should respond_to(:output)
-    end
   end
   
   describe "active sources" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: benschwarz-smoke
 version: !ruby/object:Gem::Version 
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors: 
 - Ben Schwarz
@@ -52,6 +52,7 @@ files:
 - lib/smoke/source
 - lib/smoke/source/data.rb
 - lib/smoke/source/feed.rb
+- lib/smoke/source/join.rb
 - lib/smoke/source/yql.rb
 - lib/smoke.rb
 - spec/core_ext
@@ -62,6 +63,7 @@ files:
 - spec/smoke/source
 - spec/smoke/source/data_spec.rb
 - spec/smoke/source/feed_spec.rb
+- spec/smoke/source/join_spec.rb
 - spec/smoke/source/yql_spec.rb
 - spec/smoke_spec.rb
 - spec/spec.opts
@@ -98,7 +100,7 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.2.0
 signing_key: 
-specification_version: 3
+specification_version: 2
 summary: smoke is a DSL that allows you to take data from YQL, RSS / Atom
 test_files: []