sticky_blox 1.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jason Rogers
+
+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.rdoc

@@ -0,0 +1,19 @@
+= sticky_blox
+
+StickyBlox is a late binding traits-approach to Ruby meta-programming. It allows you to define
+functionality within a class or object and apply that functionality to instances of other objects
+without having to know anything about how those other objects are created.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Jason Rogers. See LICENSE for details.

data/README.textile

@@ -0,0 +1,91 @@
+h2. What is StickyBlox?
+
+StickyBlox is a late binding traits-approach to Ruby meta-programming. It allows you to define
+functionality within a class or object and apply that functionality to instances of other objects
+without having to know anything about how those other objects are created.
+
+h2. Why?
+
+If you're thinking to yourself, "I could just open a class and directly add the methods I want, and
+get the same behavior, or I could create a module and extend or include it where ever I want..." you
+would be right. So, why use StickyBlox? It's really a matter of taste. Sometimes, I don't like opening
+other classes to add my application specific behavior, and I would rather have somewhere else in which
+to encapsulate that behavior. I would also like to be able to reuse that behavior with any object
+without having to add the methods to every class in the system. StickyBlox allows you have the behavior
+shoe-horned into classes such that the functionalities (sticks) become instance methods or just have
+the stick available to be bound to anything, at anytime.
+
+h2. Example
+
+With the later releases of Sinatra, your code is not reload-able in development. You either have to
+restart your server (which can be very burndensome, especially if you have a long start up time) or
+you have to run your application through some Shotgun or something similar.
+
+Here we define a reloader for your route implementations. With this you can pull the logic or your
+routes out to well-defined components and then reload those components at run-time to get new behavior.
+
+h3. app.rb
+
+<pre><code>
+require 'reloading'
+
+ReloadableRoutes.stick_to Sinatra::Application
+
+get "/reload/:file/?" do
+  reload
+end
+
+get "/touch_current_user/?" do
+  touch_current_user
+end
+
+put "/run_as_someone_else/?" do
+  # is the current user allowed to masquerade?
+  current_user = session[:current_user]
+  raise "unauthorized" unless current_user.allowed_to_masquerade_as_someone_else?
+
+  # let's track the fact that our current user is masquerading
+  touch_current_user
+  
+  # do some other marvelous stuff, but let's not argue about the use-cases of such a route
+  
+  # finally let's reset the application state for the current user
+  session[:current_user] = current_user
+end
+
+['table1', 'table2'].each do |table_name|
+  get table_name do
+    load_records_for(table_name)
+  end
+end
+</code></pre>
+
+h3. reloading.rb
+
+<pre><code>
+require 'sticky_blox'
+
+class ReloadableRoutes
+  include StickyBlox
+  
+  stick :reload do
+    # params comes from the instance of the Sinatra application into
+    # which this stick is bound
+    raise "no file specified" unless params[:file]
+    load params[:file]
+    "Success"
+  end
+  
+  stick :touch_current_user do
+    # use the instance variables typically available to an instance of a
+    # Sinatra::Application, or subclass, to update some aspect of the system
+    session[:current_user].touch
+  end
+
+  stick :load_records_for {|some_table_name|
+    # again, params comes from the instance of the Sinatra application
+    # into which this stick is bound
+    model_for(some_table_name).filter(params[some_table_name]).all
+  }
+end
+</code></pre>

data/TODO

@@ -0,0 +1 @@
+Anything?

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/sticky_blox/behavior.rb

@@ -0,0 +1,34 @@
+require File.join( File.dirname(__FILE__), 'proc_extension' )
+
+module StickyBlox
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def stick_to binding
+      (class << self; self; end).instance_eval do
+        clz = self
+        @stuck_methods.each do |route_name|
+          binding.class_eval do
+            define_method route_name do | *args |
+              clz.send(route_name).bind(self).call(*args)
+            end
+          end
+        end
+      end
+    end
+
+    def stick name, &block
+      (class << self; self; end).instance_eval do
+        @stuck_methods ||= []
+        @stuck_methods << name unless @stuck_methods.include?(name)
+      end
+      self.class.class_eval do
+        define_method name do
+          block
+        end
+      end
+    end
+  end
+end

data/lib/sticky_blox/proc_extension.rb

@@ -0,0 +1,19 @@
+begin
+  Proc.instance_method(:bind)
+rescue NameError
+  # Proc instance don't respond to :bind, so let's define it
+  class Proc
+    # this was lifted from the facets project (facets.rubyforge.org)
+    # which in turn was lifted from Rails
+    def bind(object)
+      block, time = self, Time.now
+      (class << object; self; end).class_eval do
+        method_name = "__bind_#{time.to_i}_#{time.usec}"
+        define_method(method_name, &block)
+        method = instance_method(method_name)
+        remove_method(method_name)
+        method
+      end.bind(object)
+    end
+  end
+end

data/lib/sticky_blox.rb

@@ -0,0 +1 @@
+require File.join( File.dirname(__FILE__), 'sticky_blox', 'behavior' )

data/spec/helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'spec'
+require 'spearmint'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'sticky_blox'

data/spec/spearmint.rb

@@ -0,0 +1,19 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'sticky_blox')
+
+class Spearmint
+  include StickyBlox
+
+  stick :chew do
+    raise "ah, ah, ah ... I ain't no reverse-able object. I'm a #{self.class}" unless self.respond_to?(:reverse)
+    self.reverse
+  end
+
+  stick :chew_it_up_and_spit_it_out do
+    raise "ah, ah, ah ... I ain't no reverse-able object. I'm a #{self.class}" unless self.respond_to?(:reverse!)
+    self.reverse!
+  end
+  
+  stick :open do |how_many_pieces|
+    (1..(how_many_pieces || self).to_i).collect
+  end
+end

data/spec/sticky_blox_spec.rb

@@ -0,0 +1,48 @@
+require 'helper'
+
+describe "Instance-based approaches" do
+  class Doublemint < Spearmint
+  end
+  
+  it "Doublemint shouldn't have sticks to use" do
+    proc{Doublemint.stick_to Object}.should raise_error(NameError)
+  end
+
+  it 'should be bound to any string' do
+    Spearmint.stick_to String
+    s = "abc"
+    s1 = s.chew
+    s1.should == s.reverse
+    
+    s = "Spearmint"
+    s2 = "tnimraepS"
+    s1 = s.chew_it_up_and_spit_it_out
+    s1.should == s2
+    s1.should === s
+  end
+  
+  it "should turn the String into an Integer and return an array of numbers" do
+    thing = "2"
+    thing.open.should == [1, 2]
+    thing.open(5).should == [1, 2, 3, 4, 5]
+  end
+end
+
+describe "Class-based approaches" do
+  it 'should be able to bind to the instance of any object' do
+    s  = %w{a b c}
+    s1 = Spearmint.chew.bind(s).call
+    s1.should == %w{c b a}
+    
+    s  = %w{a b c}
+    s2 = %w{c b a}
+    s1 = Spearmint.chew_it_up_and_spit_it_out.bind(s).call
+    s1.should == s2
+    s1.should == s
+  end
+  
+  it "should throw an error when binding to something other than a String" do
+    thing = Object.new
+    proc {Spearmint.chew.bind(thing).call}.should raise_error
+  end
+end

data/sticky_blox.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sticky_blox}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jason Rogers"]
+  s.date = %q{2010-04-12}
+  s.description = %q{see http://github.com/jacaetevha/sticky_blox for more description. I'm lazy}
+  s.email = %q{jacaetevha@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc",
+     "README.textile",
+     "TODO"
+  ]
+  s.files = [
+    "LICENSE",
+     "README.rdoc",
+     "README.textile",
+     "TODO",
+     "VERSION",
+     "lib/sticky_blox.rb",
+     "lib/sticky_blox/behavior.rb",
+     "lib/sticky_blox/proc_extension.rb",
+     "spec/helper.rb",
+     "spec/spearmint.rb",
+     "spec/sticky_blox_spec.rb",
+     "sticky_blox.gemspec"
+  ]
+  s.homepage = %q{http://github.com/jacaetevha/sticky_blox}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Late-binding traits for Ruby}
+  s.test_files = [
+    "spec/helper.rb",
+     "spec/spearmint.rb",
+     "spec/sticky_blox_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.3.0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.3.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.3.0"])
+  end
+end
+

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: sticky_blox
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jason Rogers
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-12 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id001
+description: see http://github.com/jacaetevha/sticky_blox for more description. I'm lazy
+email: jacaetevha@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+- README.textile
+- TODO
+files: 
+- LICENSE
+- README.rdoc
+- README.textile
+- TODO
+- VERSION
+- lib/sticky_blox.rb
+- lib/sticky_blox/behavior.rb
+- lib/sticky_blox/proc_extension.rb
+- spec/helper.rb
+- spec/spearmint.rb
+- spec/sticky_blox_spec.rb
+- sticky_blox.gemspec
+has_rdoc: true
+homepage: http://github.com/jacaetevha/sticky_blox
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Late-binding traits for Ruby
+test_files: 
+- spec/helper.rb
+- spec/spearmint.rb
+- spec/sticky_blox_spec.rb