context_exposer 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12da37ed9022c53dd944d8c73f53c0da2980a65f
-  data.tar.gz: 7cd49fd373d8ea82633f36064c21eb95303e3ab4
+  metadata.gz: 2452c12a649755432297fcee4e4fefb40b864313
+  data.tar.gz: 8ace695b9b00d9f114874aa9b5719064c64a0c83
 SHA512:
-  metadata.gz: 4cc5284dce7e9ac8c4d9afd9470cbd69e6f29f2bcc2c75749439ad195a86326e9848dd292db2cc1e8f2d31641eee89d28198e43620d295fe930a39bb631524a9
-  data.tar.gz: 92d81c8be3d0dd2dd4e067f3c3c1a73837319d01ffeaaba0a2c4f29890e89caaa75960b7650994ade13f545c0446339bcc69f3aa57428679500d14e94d293b61
+  metadata.gz: 78721b922904ab3222e41024042691c3998103414314a5f4adf75bf8b34fd6c9a529c7acee68c23af948219b3577727276ffb1c617fd8d1ed21dc93a92484d47
+  data.tar.gz: c0bcbf8cb1781b7fc39f0b1d6246c7b11f931056925f64becd31ab19f3e76606b996b4faa5e67470ec8c407c4dc86bb9ba4c369fe7bfae23330a33f1914bec34

data/Gemfile

@@ -3,20 +3,6 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in context_exposer.gemspec
 gemspec
 
-gem 'pry'
 gem 'rails', '>= 3.1'
-
-gem "rspec-rails", :group => [:test, :development]
-
-group :test do
-  # gem 'factory_girl_rails', :require => false
-  # gem "capybara"
-  # gem "capybara-webkit"
-  # gem 'growl'  
-  # gem "spork"
-  # gem "guard"
-  # gem "guard-bundler"
-  # gem "guard-rspec"
-  # gem "guard-spork"
-  # gem "launchy"
-end
+gem "rspec-rails", '>= 2.0', group: [:test, :development]
+gem 'pry',         group: [:development]

data/README.md

@@ -36,6 +36,14 @@ class PostsController < ActionController::Base
 end
 ```
 
+HAML view example
+
+```haml
+%h1 Posts
+= context.posts.each do |post|
+  %h2 = post.name
+```
+
 You can also define your own subclass of `ViewContext` and designate an instance of this custom class as your "exposed" target, via  `view_context_class`method.
 
 Example:
@@ -47,7 +55,7 @@ class PostsController < ActionController::Base
   view_context_class :posts_view_context
 
   exposed(:post)  { Post.find params[:id] }
-  exposed(:posts) { Post.find params[:id] }
+  exposed(:posts) { Post.all }
 end
 ```
 
@@ -78,29 +86,78 @@ class PostsViewContext < ContextExposer::ViewContext
 end
 ```
 
+HAML view example
+
+```haml
+%h1 Admin Posts
+= context.admin_posts.each do |post|
+  %h2 = post.name
+```
+
+
 This opens up some amazing possibilities to really put the logic where it belongs.The custom ViewContext would benefit from having the "admin" and "user" logic extracted either to separate modules or a custom ViewContext base class ;)
 
 This approach opens up many new exciting ways to slice and dice your logic in a much better way, a new *MVC-C* architecture, the extra "C" for *Context*.
 
+### ResourceController
 
-## TODO
+The `ResourceController` automatically sets up the typical singular and plural-form resource helpers.
 
-Add some useful subclasses of `BaseController`, that add some extra magic!
-Also add some basic modules to integrate with typical authentication solutions etc. Get inspiration from other similar gems, fx `decent_exposure`. Allow for integration between these different solutions.
+This simplifies the above `PostsController` example to this:
 
-### ResourceController
+```ruby
+class PostsController < ActionController::Base
+  include ContextExposer::ResourceController
+end
+```
+
+`ResourceController`  uses the following internal logic for its default functionality. You can override these methods to customize your behavior as needed.
 
-It sould be nice to have a `ResourceController` to automatically set up the typical singular and plural-form resource helpers.
+```ruby
+module ContextExposer::ResourceController
+  # ...
+
+  protected
+
+  def resource_id
+    params[:id]
+  end
+
+  def find_single_resource
+    self.class._the_resource.find resource_id
+  end
+
+  def find_all_resources
+    self.class._the_resource.all
+  end
+```
 
-This would simplify the above `PostsController` example to this:
+## Integration with decent_exposure gem
+
+Initial integration support is included for `decent_exposure`, another popular gem with similar functionality. To add methods exposed by `decent_exposure` `#expose` to the context object, simply call `#context_expose_decently` or the alias method `#expose_decently`.
 
 ```ruby
+# using gem 'decent_exposure'
+# auto-included in ActionController::Base
+
 class PostsController < ActionController::Base
   include ContextExposer::ResourceController
+
+  expose(:posts)
+  expose(:post) { Post.first}
+  expose(:postal)
+
+  context_expose_decently except: 'postal'
 end
 ```
 
-Please help out :)
+HAML view example
+
+```haml
+%h1 Posts
+= context.posts.each do |post|
+  %h2 = post.name
+```
 
 ## Contributing
 

data/lib/context_exposer.rb

@@ -5,4 +5,5 @@ end
 
 require "active_support"
 require "context_exposer/base_controller"
+require "context_exposer/resource_controller"
 require "context_exposer/view_context"

data/lib/context_exposer/base_controller.rb

@@ -5,6 +5,8 @@ module ContextExposer::BaseController
     before_filter :configure_exposed_context
 
     expose_context :context
+
+    # set_callback :process_action, :before, :configure_exposed_context
   end
 
   def view_context    
@@ -18,6 +20,26 @@ module ContextExposer::BaseController
       exposure_storage[name.to_sym] = block
     end
 
+    # expose all exposures exposed by decent_exposure to context
+    def context_expose_decently options = {}
+      transfer_keys = _exposures.keys
+      except = (options[:except] || {}).map(&:to_sym)
+      only = (options[:only] || {}).map(&:to_sym)
+
+      transfer_keys = transfer_keys - except
+
+      unless only.empty?
+        transfer_keys.select {|k| only.include? k.to_sym } 
+      end
+
+      transfer_keys.each do |exposure|
+        exposed exposure do
+          send(exposure)
+        end
+      end
+    end
+    alias_method :expose_decently, :context_expose_decently 
+
     def view_context_class name
       define_method :view_context_class do
         @view_context_class ||= name.kind_of?(Class) ? name : name.to_s.camelize.constantize
@@ -28,6 +50,7 @@ module ContextExposer::BaseController
 
     def expose_context name
       return if exposed_view_context?
+
       if ActionController::Base.instance_methods.include?(name.to_sym)
         Kernel.warn "[WARNING] You are exposing the `#{name}` method, " \
           "which overrides an existing ActionController method of the same name. " \
@@ -40,7 +63,7 @@ module ContextExposer::BaseController
     end
 
     def exposed_view_context?
-      @exposed_view_context ||= false
+      @exposed_view_context == true
     end
 
     def exposure_storage
@@ -57,10 +80,10 @@ module ContextExposer::BaseController
     return if configured_exposed_context?
     clazz = self.class
     exposed_methods = clazz.send(:exposure_hash)[clazz.to_s] || []
-    # puts "exposed_methods for: #{clazz} - #{exposed_methods}"
     exposed_methods.each do |name, procedure|
+      this = self
       view_context.send :define_singleton_method, name do 
-        procedure.call
+        this.instance_eval(&procedure)
       end
     end
     @configured_exposed_context = true

data/lib/context_exposer/resource_controller.rb

@@ -0,0 +1,47 @@
+module ContextExposer::ResourceController
+  extend ActiveSupport::Concern
+  include ContextExposer::BaseController
+
+  included do
+    puts "included: #{_normalized_resource_name}"
+
+    exposed(_normalized_resource_name.singularize) do
+      find_single_resource
+    end
+
+    exposed(_normalized_resource_name.pluralize)    { find_all_resources }
+    exposed(_normalized_resource_list)              { find_all_resources.to_a }
+  end
+
+  protected
+
+  def resource_id
+    params[:id]
+  end
+
+  def find_single_resource
+    self.class._the_resource.find resource_id
+  end
+
+  def find_all_resources
+    self.class._the_resource.all
+  end
+
+  module ClassMethods
+    def _the_resource
+      clazz_name = self.to_s.sub(/Controller$/, '').singularize
+      clazz_name.constantize
+    rescue NameError => e
+      raise "Resource #{clazz_name} is not defined. #{e}"
+    end
+
+    def _normalized_resource_list
+      _normalized_resource_name.pluralize + '_list'
+    end
+
+    def _normalized_resource_name
+      self.to_s.demodulize.sub(/Controller$/, '').underscore
+    end
+  end
+end
+

data/lib/context_exposer/version.rb

@@ -1,3 +1,3 @@
 module ContextExposer
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/context_exposer/expose_resource_spec.rb

@@ -0,0 +1,103 @@
+require 'context_exposer'
+# require 'rails'
+require 'action_controller'
+
+class Post
+  attr_accessor :name
+
+  def initialize name
+    @name = name
+    Post.add self
+  end
+
+  def self.find id
+    list.first
+  end
+
+  def self.all
+    Post.list
+  end
+
+  protected
+
+  def self.add post
+    list << post
+  end
+
+  def self.list
+    @list ||= []
+  end
+end
+
+class PostsController < ActionController::Base
+  include ContextExposer::ResourceController
+  
+  def show
+    configure_exposed_context
+  end
+
+  def index
+  end
+
+  protected
+
+  def params
+    {id: 1}
+  end
+end
+
+describe ContextExposer::ResourceController do
+  describe "controller" do
+    subject { controller }
+
+    let(:controller) { PostsController.new }
+
+    before :all do
+      @post1 = Post.new 'My 1st post'
+      @post2 = Post.new 'My 2nd post'
+    end
+
+    context 'show post' do
+      # run action post
+      before :each do        
+        controller.show
+      end
+
+      it 'defines :show as an action_method' do
+        expect(subject.action_methods).to include('show')
+      end
+
+      it "defines a method context" do
+        expect(subject).to respond_to(:context)
+      end
+
+      it "exposes the context to the view layer as a helper" do
+        expect(subject._helper_methods).to include(:context)
+      end
+
+      context 'context' do
+        subject { controller.context }
+
+        it "is an instance of ContextExposer::ViewContext" do
+          expect(subject).to be_a ContextExposer::ViewContext
+        end      
+
+        it "defines a method :post" do
+          expect(subject).to respond_to(:post)
+        end      
+
+        it "defines a method :posts" do
+          expect(subject).to respond_to(:posts)
+        end      
+
+        it "calling method :post returns 'My 1st post' " do
+          expect(subject.post.name).to eq @post1.name
+        end      
+
+        it "calling method :posts returns all posts " do
+          expect(subject.posts).to eq [@post1, @post2]
+        end      
+      end
+    end
+  end
+end

data/spec/context_exposer/expose_spec.rb

@@ -4,10 +4,20 @@ require 'action_controller'
 class MyController < ActionController::Base
   include ContextExposer::BaseController
   
-  exposed(:post) { Post.find params[:id] }
+  exposed(:bird) { "Bird" }
 
-  def post
+  # since: extend DecentExposure::Exposure
+  def self._exposures
+    {decent: 'hi', hello: 'yo!'}
+  end  
+
+  expose_decently except: %w{hello}
+
+  def show
+    configure_exposed_context
   end
+
+  protected
 end
 
 class MyCoolController < ActionController::Base
@@ -21,7 +31,9 @@ class MyCoolController < ActionController::Base
     configure_exposed_context
   end
 
-  def params; end
+  protected
+
+  def params; end  
 end
 
 class MegaCoolViewContext < ContextExposer::ViewContext
@@ -43,11 +55,11 @@ describe ContextExposer::BaseController do
 
     # run action post
     before :each do
-      controller.post
+      controller.show
     end
 
-    it 'defines :post as an action_method' do
-      expect(subject.action_methods).to include('post')
+    it 'defines :show as an action_method' do
+      expect(subject.action_methods).to include('show')
     end
 
     it "defines a method context" do
@@ -77,6 +89,14 @@ describe ContextExposer::BaseController do
         expect(subject).to respond_to(:bird)
       end      
 
+      it "defines a method :decent" do
+        expect(subject).to respond_to(:decent)
+      end      
+
+      it "does not defines a decent method :hello" do
+        expect(subject).to_not respond_to(:hello)
+      end      
+
       it "calling method :bird returns 'Bird' " do
         expect(subject.bird).to eq "Bird"
       end      

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: context_exposer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Kristian Mandrup
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-14 00:00:00.000000000 Z
+date: 2013-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -55,9 +55,11 @@ files:
 - context_exposer.gemspec
 - lib/context_exposer.rb
 - lib/context_exposer/base_controller.rb
+- lib/context_exposer/resource_controller.rb
 - lib/context_exposer/version.rb
 - lib/context_exposer/view_context.rb
 - spec/app/posts_spec.rb
+- spec/context_exposer/expose_resource_spec.rb
 - spec/context_exposer/expose_spec.rb
 - spec/dummy/README.rdoc
 - spec/dummy/Rakefile
@@ -122,6 +124,7 @@ summary: The Context object becomes the single communication point between View
   Controller
 test_files:
 - spec/app/posts_spec.rb
+- spec/context_exposer/expose_resource_spec.rb
 - spec/context_exposer/expose_spec.rb
 - spec/dummy/README.rdoc
 - spec/dummy/Rakefile