dead_simple_cms 0.9.4 → 0.10.0

data/lib/dead_simple_cms.rb

@@ -29,7 +29,8 @@ require 'dead_simple_cms/attribute/type/all'
 
 require 'dead_simple_cms/group'
 require 'dead_simple_cms/group/configuration'
-require 'dead_simple_cms/group/presenter'
+require 'dead_simple_cms/group/presenter/base'
+require 'dead_simple_cms/group/presenter/render_mixin'
 
 require 'dead_simple_cms/section'
 require 'dead_simple_cms/section/builder'
@@ -51,6 +52,10 @@ if defined?(ActionController)
   require 'dead_simple_cms/rails/action_controller/fragment_sweeper'
 end
 
+if defined?(Rails)
+  require 'dead_simple_cms/rails/railtie'
+end
+
 module DeadSimpleCMS
 
   extend self

data/lib/dead_simple_cms/attribute/type/base.rb

@@ -22,7 +22,6 @@ module DeadSimpleCMS
 
         VALID_INPUT_TYPES = [:string, :text, :select, :file, :radio].freeze
 
-
         attr_reader   :hint, :input_type, :group_hierarchy, :required
         attr_accessor :section
 

data/lib/dead_simple_cms/group.rb

@@ -5,7 +5,11 @@ module DeadSimpleCMS
 
     ROOT_IDENTIFIER = :root
 
-    attr_reader :groups, :presenter_class, :render_proc
+    attr_reader :groups
+    attr_accessor :parent
+
+    require 'dead_simple_cms/group/presenter/render_mixin'
+    include Presenter::RenderMixin
 
     def initialize(identifier, options={})
       @groups = DeadSimpleCMS::Group.new_dictionary
@@ -16,37 +20,18 @@ module DeadSimpleCMS
       new(ROOT_IDENTIFIER)
     end
 
-    # Public: Set different mechanisms for rendering this group.
-    def display(presenter_class=nil, &block)
-      @presenter_class = presenter_class
-      @render_proc = block
-    end
-
     # Public: Exend functionality for the current group.
     def extend(*modules, &block)
       modules << Module.new(&block) if block_given?
       super(*modules)
     end
 
-    # Public: If a presenter class was specified, returns an instance of the presenter.
-    def presenter(view_context, *args)
-      @presenter_class.new(view_context, *args) if @presenter_class
-    end
-
-    # Public: Render the group using the passed in proc in the scope of the template.
-    def render(view_context, *args)
-      if @render_proc
-        view_context.instance_exec(self, *args, &@render_proc)
-      elsif presenter = presenter(view_context, self, *args)
-        presenter.render
-      end
-    end
-
     def root?
       identifier == ROOT_IDENTIFIER
     end
 
     def add_group(group)
+      group.parent = self
       groups.add(group)
       group_accessor(group)
     end

data/lib/dead_simple_cms/group/configuration.rb

@@ -4,7 +4,10 @@ module DeadSimpleCMS
 
       include Util::Identifier
 
-      attr_reader :options, :attribute_arguments, :presenter_class, :render_proc
+      require 'dead_simple_cms/group/presenter/render_mixin'
+      include Presenter::RenderMixin
+
+      attr_reader :options, :attribute_arguments
 
       def initialize(identifier, options={}, &block)
         super(identifier, options)
@@ -13,11 +16,6 @@ module DeadSimpleCMS
         instance_eval(&block)
       end
 
-      def display(presenter_class=nil, &block)
-        @presenter_class = presenter_class if presenter_class
-        @render_proc = block if block_given?
-      end
-
       def self.define_attribute_builder_method(klass)
         class_eval <<-RUBY, __FILE__, __LINE__ + 1
           def #{klass.builder_method_name}(identifier, options={})

data/lib/dead_simple_cms/group/presenter/base.rb

@@ -0,0 +1,29 @@
+require 'delegate'
+module DeadSimpleCMS
+  class Group
+    # Public: Presenter class used for rendering groups.
+    #
+    # Within the context of this group, you can call methods as if you were in the view_context.
+    module Presenter
+      class Base < SimpleDelegator
+
+        attr_reader :group
+
+        def initialize(view_context, group, *args)
+          @group = group
+          initialize_extra_arguments(*args)
+          super(view_context)
+        end
+
+        # Private: Initialize extra arguments for the presenter.
+        def initialize_extra_arguments(*args)
+        end
+
+        def render
+          raise(NotImplementedError, "Please define your own #render method.")
+        end
+
+      end
+    end
+  end
+end

data/lib/dead_simple_cms/group/presenter/render_mixin.rb

@@ -0,0 +1,42 @@
+require 'delegate'
+module DeadSimpleCMS
+  class Group
+    module Presenter
+      # Public: Module to add rendering of lambda and presenters for DeadSimpleCMS::Group.
+      module RenderMixin
+
+        def presenter_class
+          display if display.is_a?(Class) && display < Presenter::Base
+        end
+
+        def render_proc
+          display if display.is_a?(Proc)
+        end
+
+        # Public: Set different mechanisms for rendering this group.
+        def display(presenter_class_or_block=nil, &block)
+          @display = presenter_class_or_block if presenter_class_or_block
+          @display = block if block_given?
+          @display
+        end
+
+        # Public: Render the group using the passed in proc in the scope of the template.
+        #
+        # If you include this module in something other then a DeadSimpleCMS::Group, you can pass in the +group+ directly with
+        # the first argument:
+        #
+        #   render([view_context, group], *args) # and also
+        #   render(view_context, *args)
+        #
+        def render(view_context, *args)
+          view_context, group = view_context.is_a?(Array) ? view_context : [view_context, self]
+          case display
+          when Proc  then view_context.instance_exec(group, *args, &display)
+          when Class then display.new(view_context, group, *args).render if display < Presenter::Base
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/dead_simple_cms/rack/section_refresher.rb

@@ -0,0 +1,20 @@
+require 'rack'
+module DeadSimpleCMS
+  module Rack
+    # Public: Refresh the DeadSimpleCMS values in between requests. Since DeadSimpleCMS stores all the attributes for a
+    # section in a serialized format, we cache the storage mechanism on a per-request basis to avoid unnecessary hits
+    # to the cache, whether it be Redis, Memcache, or the Database.
+    class SectionRefresher
+
+      def initialize(app, options = {})
+        @app = app
+      end
+
+      def call(env)
+        DeadSimpleCMS.sections.values.each(&:refresh!)
+        @app.call(env)
+      end
+
+    end
+  end
+end

data/lib/dead_simple_cms/rails/railtie.rb

@@ -0,0 +1,12 @@
+module DeadSimpleCMS
+  module Rails
+    class Railtie < ::Rails::Railtie
+
+      initializer "dead_simple_cms.section_refresher" do |app|
+        require 'dead_simple_cms/rack/section_refresher'
+        app.config.middleware.use(DeadSimpleCMS::Rack::SectionRefresher)
+      end
+
+    end
+  end
+end

data/lib/dead_simple_cms/section.rb

@@ -52,6 +52,11 @@ module DeadSimpleCMS
       @storage ||= storage_class.new(self)
     end
 
+    # Public: Clears out the storage so new values can be repopulated. Used primarily to clear the values between refreshes.
+    def refresh!
+      @storage = nil
+    end
+
     # Public: Update the section values.
     #
     # Examples

data/lib/dead_simple_cms/version.rb

@@ -1,3 +1,3 @@
 module DeadSimpleCMS
-  VERSION = "0.9.4"
+  VERSION = "0.10.0"
 end

data/spec/dead_simple_cms/attribute/collection_spec.rb

@@ -29,7 +29,10 @@ describe DeadSimpleCMS::Attribute::Collection do
 
     let(:string_attribute) { DeadSimpleCMS::Attribute::Type::String.new(:string_attr) }
 
-    before(:each) { subject.add_attribute(string_attribute) }
+    before(:each) do
+      string_attribute.stub(:attributes_from_storage).and_return({})
+      subject.add_attribute(string_attribute)
+    end
 
     it "should create a getter method" do
       string_attribute.stub(:value).and_return("value")

data/spec/dead_simple_cms/attribute/type/all_spec.rb

@@ -215,8 +215,10 @@ describe DeadSimpleCMS::Attribute::Type::File do
       end
 
       before(:each) do
+        subject.stub(:attributes_from_storage).and_return({})
         subject.uploader_class = file_uploader_class
       end
+
       it "should call upload!" do
         subject.should_receive(:upload!).once
         subject.upload!

data/spec/dead_simple_cms/attribute/type/base_spec.rb

@@ -21,6 +21,10 @@ describe DeadSimpleCMS::Attribute::Type::Base do
   subject { fake_attribute_class.new(:fake_identifier, :label => "Fake Label", :default => 413, :hint => "some hint",
     :group_hierarchy => group_hierarchy) }
 
+  before(:each) do
+    subject.stub(:attributes_from_storage).and_return({})
+  end
+
   describe ".builder_method_name" do
     it "should derive from the class name" do
       fake_attribute_class.builder_method_name.should == "fake_attribute"
@@ -71,14 +75,22 @@ describe DeadSimpleCMS::Attribute::Type::Base do
 
   describe "#value" do
 
-    context "when @value is set" do
-      before(:each) { subject.instance_variable_set(:@value, nil) }
+    context "when value is in attributes_from_storage" do
+      before(:each) do
+        subject.stub(:section_identifier).and_return(:foo)
+        subject.stub(:attributes_from_storage).and_return(:foo => 3)
+      end
 
-      its(:value) { should be nil }
+      its(:value) { should == 3 }
+
+      context "and value is storage is nil and default is not nil" do
+
+        before(:each) do
+          subject.stub(:default).and_return(true)
+          subject.stub(:attributes_from_storage).and_return(:foo => nil)
+        end
 
-      it "should not attempt to hit the storage" do
-        subject.should_receive(:attributes_from_storage).never
-        subject.value
+        its(:value) { should be_nil }
       end
     end
 

data/spec/dead_simple_cms/group/presenter/render_mixin_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+describe DeadSimpleCMS::Group::Presenter::RenderMixin do
+
+  subject { Class.new { include DeadSimpleCMS::Group::Presenter::RenderMixin }.new }
+
+  shared_context :presenter_class do
+    let(:presenter_class) { Class.new(DeadSimpleCMS::Group::Presenter::Base) { def render ; "render result" ; end } }
+    before(:each) { subject.display(presenter_class) }
+  end
+
+  describe "#render" do
+    context "when presenter_class is set" do
+
+      include_context :presenter_class
+
+      specify { subject.render(:view_context).should == "render result" }
+
+    end
+
+    context "when render_proc is set" do
+
+      before(:each) { subject.display { |group, first, second| "#{first} #{second}" } }
+
+      specify { subject.render(:view_context, :first_arg, :second_arg).should == "first_arg second_arg" }
+
+      context "and when group is passed in arguments" do
+        let(:group) { DeadSimpleCMS::Group.new(:group_identifier) }
+        before(:each) { subject.display { |group, arg1, arg2| "#{group.identifier} #{arg1} #{arg2}" } }
+
+        it "should use the passed in group for the render_proc" do
+          subject.render([:view_context, group], "arg1", "arg2").should == "group_identifier arg1 arg2"
+        end
+      end
+
+    end
+
+    context "when group is passed in" do
+      include_context :presenter_class
+
+      it "should use that as the group" do
+        presenter_class.stub(:new).with(:view_context, :group).and_return(double(:render => :result))
+        subject.render([:view_context, :group])
+      end
+
+    end
+  end
+end
+

data/spec/dead_simple_cms/group/presenter_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-describe DeadSimpleCMS::Group::Presenter do
+describe DeadSimpleCMS::Group::Presenter::Base do
 
   let(:view_context) { double("view context") }
   let(:group) { DeadSimpleCMS::Group.new(:group_identifier) }

data/spec/dead_simple_cms/group_spec.rb

@@ -14,22 +14,6 @@ describe DeadSimpleCMS::Group do
     specify { described_class.root.should be_an_instance_of described_class }
   end
   
-  describe "#presenter" do
-    context "when presenter_class is set" do
-
-      let(:presenter_class) { Struct.new(:view_context) }
-
-      before(:each) { subject.display(presenter_class) }
-
-      specify { subject.presenter(:view_context).should be_an_instance_of presenter_class }
-
-    end
-  end
-  
-  describe "#render" do
-  
-  end
-  
   describe "#root?" do
 
     its(:root?) { should be false }
@@ -59,6 +43,10 @@ describe DeadSimpleCMS::Group do
       subject.nested_group_attributes = :value
     end
 
+    it "should set the parent" do
+      nested_group.parent.should == subject
+    end
+
   end
   
 end

data/spec/dead_simple_cms/section_spec.rb

@@ -55,6 +55,15 @@ describe DeadSimpleCMS::Section do
   describe "#storage" do
     specify { subject.storage.should be_a DeadSimpleCMS::Storage::Base }
   end
+
+  describe "#refresh!" do
+    before(:each) do
+      subject.instance_variable_set(:@storage, :some_value)
+      subject.refresh!
+    end
+
+    specify { subject.instance_variable_get(:@storage).should be_nil }
+  end
   
   describe "#update_attributes" do
     before(:each) do

data/spec/dead_simple_cms/util/identifier/dictionary_spec.rb

@@ -2,41 +2,65 @@ require "spec_helper"
 
 describe DeadSimpleCMS::Util::Identifier::Dictionary do
 
-  before(:each) do
-  
+  class ClassWithIdentifier
+    include DeadSimpleCMS::Util::Identifier
+    alias :some_method :identifier
   end
-  
+
+  subject { described_class.new(ClassWithIdentifier, :identifier_method => :some_method)  }
+
+  its(:identifier_method) { should == :some_method }
+  its(:target_class) { should == ClassWithIdentifier }
+
+  context "when items are added " do
+    let(:instance_with_identifier_1) { ClassWithIdentifier.new("basketball") }
+    let(:instance_with_identifier_2) { ClassWithIdentifier.new("soccer") }
+
+    before(:each) do
+      subject.add(instance_with_identifier_1)
+      subject.add(instance_with_identifier_2)
+    end
+
+    its(:identifiers) { should include(:basketball, :soccer) }
+
+    it "should be indexed by the identifier" do
+      subject[:basketball].should == instance_with_identifier_1
+      subject[:soccer].should == instance_with_identifier_2
+    end
+
+  end
+
   describe "#target_class" do
-  
+
   end
-  
+
   describe "#identifier_method" do
-  
+
   end
-  
+
   describe "#identifiers" do
-  
+
   end
-  
+
   describe "#add" do
-  
+
   end
-  
+
   describe "#include?" do
-  
+
   end
-  
+
   describe "#to_hash" do
-  
+
   end
-  
+
   describe "#[]=" do
-  
+
   end
-  
+
   describe "#[]" do
-  
+
   end
-  
+
 end
 

data/spec/setup/banner_presenter.rb

@@ -1,5 +1,5 @@
 module DeadSimpleCMS
-  class BannerPresenter < DeadSimpleCMS::Group::Presenter
+  class BannerPresenter < DeadSimpleCMS::Group::Presenter::Base
 
     attr_reader :coupon, :options, :size
 

data/spec/setup/shared.rb

@@ -46,8 +46,9 @@ shared_examples :group_display do
   describe "#display" do
     context "when presenter_class is set" do
       it "should set the @presenter_class variable" do
-        subject.display :presenter_class
-        subject.instance_variable_get(:@presenter_class).should == :presenter_class
+        klass = Class.new(DeadSimpleCMS::Group::Presenter::Base)
+        subject.display klass
+        subject.presenter_class.should == klass
       end
     end
 
@@ -55,7 +56,7 @@ shared_examples :group_display do
       it "should set it to the @render_proc" do
         proc = lambda { "do something" }
         subject.display(&proc)
-        subject.instance_variable_get(:@render_proc).should == proc
+        subject.render_proc.should == proc
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dead_simple_cms
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.10.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-26 00:00:00.000000000 -07:00
+date: 2012-06-29 00:00:00.000000000 -07:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2161736340 !ruby/object:Gem::Requirement
+  requirement: &2157724540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2161736340
+  version_requirements: *2157724540
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &2161735820 !ruby/object:Gem::Requirement
+  requirement: &2157723920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2161735820
+  version_requirements: *2157723920
 - !ruby/object:Gem::Dependency
   name: simple_form
-  requirement: &2161735440 !ruby/object:Gem::Requirement
+  requirement: &2157723540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2161735440
+  version_requirements: *2157723540
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2161734880 !ruby/object:Gem::Requirement
+  requirement: &2157722900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '3.0'
   type: :development
   prerelease: false
-  version_requirements: *2161734880
+  version_requirements: *2157722900
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2161734460 !ruby/object:Gem::Requirement
+  requirement: &2157722360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2161734460
+  version_requirements: *2157722360
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &2161734000 !ruby/object:Gem::Requirement
+  requirement: &2157721800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,7 +77,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2161734000
+  version_requirements: *2157721800
 description: ! "Dead Simple CMS is a library for modifying different parts of your
   website without the overhead of having a\nfullblown CMS. The idea with this library
   is simple: provide an easy way to hook into different parts of your\napplication
@@ -113,7 +113,9 @@ files:
 - lib/dead_simple_cms/file_uploader/base.rb
 - lib/dead_simple_cms/group.rb
 - lib/dead_simple_cms/group/configuration.rb
-- lib/dead_simple_cms/group/presenter.rb
+- lib/dead_simple_cms/group/presenter/base.rb
+- lib/dead_simple_cms/group/presenter/render_mixin.rb
+- lib/dead_simple_cms/rack/section_refresher.rb
 - lib/dead_simple_cms/rails/action_controller/extensions.rb
 - lib/dead_simple_cms/rails/action_controller/fragment_sweeper.rb
 - lib/dead_simple_cms/rails/action_view/extensions.rb
@@ -122,6 +124,7 @@ files:
 - lib/dead_simple_cms/rails/action_view/form_builders/simple_form.rb
 - lib/dead_simple_cms/rails/action_view/form_builders/simple_form_with_bootstrap.rb
 - lib/dead_simple_cms/rails/action_view/presenter.rb
+- lib/dead_simple_cms/rails/railtie.rb
 - lib/dead_simple_cms/section.rb
 - lib/dead_simple_cms/section/builder.rb
 - lib/dead_simple_cms/storage/base.rb
@@ -138,6 +141,7 @@ files:
 - spec/dead_simple_cms/configuration_spec.rb
 - spec/dead_simple_cms/file_uploader/base_spec.rb
 - spec/dead_simple_cms/group/configuration_spec.rb
+- spec/dead_simple_cms/group/presenter/render_mixin_spec.rb
 - spec/dead_simple_cms/group/presenter_spec.rb
 - spec/dead_simple_cms/group_spec.rb
 - spec/dead_simple_cms/rails/action_view/form_builders/default_spec.rb
@@ -195,6 +199,7 @@ test_files:
 - spec/dead_simple_cms/configuration_spec.rb
 - spec/dead_simple_cms/file_uploader/base_spec.rb
 - spec/dead_simple_cms/group/configuration_spec.rb
+- spec/dead_simple_cms/group/presenter/render_mixin_spec.rb
 - spec/dead_simple_cms/group/presenter_spec.rb
 - spec/dead_simple_cms/group_spec.rb
 - spec/dead_simple_cms/rails/action_view/form_builders/default_spec.rb

data/lib/dead_simple_cms/group/presenter.rb

@@ -1,23 +0,0 @@
-require 'delegate'
-module DeadSimpleCMS
-  class Group
-    # Public: Presenter class used for rendering groups.
-    #
-    # Within the context of this group, you can call methods as if you were in the view_context.
-    class Presenter < SimpleDelegator
-
-      attr_reader :group
-
-      def initialize(view_context, group, *args)
-        @group = group
-        initialize_extra_arguments(*args)
-        super(view_context)
-      end
-
-      # Private: Initialize extra arguments for the presenter.
-      def initialize_extra_arguments(*args)
-      end
-
-    end
-  end
-end