adorn 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74658299c2b97f2148f863e4a0d02bdd800c5f49
-  data.tar.gz: 037a64e3129e9fdb4fb3105e6bc137e0b0eecd75
+  metadata.gz: a856199ed966d40cc4030d5e386ddb163f2cf677
+  data.tar.gz: a396250bf6f4a17855e22d9b8f28c2d668cba872
 SHA512:
-  metadata.gz: 90bf1f8055f3bc83a8b68e2e674d2fa14e756c8828a1aeae7badfd4be3ebab6969722cc468dbc028f96a8221ed2381749e2df0359f36254d59b605bca5618cbd
-  data.tar.gz: ea6a4588ffd4b22b45d60ee7c875e05df9e61579e8a672a25376d8600eca186bdce0366833ee6401026f5b24b70ff24887d29b7b804807d9292c14f0f3df4712
+  metadata.gz: 8c91111ae02408676c852c0e20ee9de70065f3825a41e84d586b901e00f6a32c6c9bf29596f0e55d1e7f680bc1b5367ede1edbb77c4b560e771bc0bea41f8146
+  data.tar.gz: fdfa4a711f668212af484060486346dad9f2d013ec83d4a4da624cde7a548b499d6c8c3ac0860dd77dfe1eb84ba8f94a77cce85dae0accdf287e50e70e330e80

data/lib/adorn/abstract_presenter.rb

@@ -1,11 +1,17 @@
 module Adorn
   class AbstractPresenter
 
+    # Macro used to create an instance method that wraps the underlying
+    # object passed to the decorator
+    #
+    # @param [Symbol]
+    # @return [Method] Adorn instance.
     def self.presents(name)
       define_method(name) { @object }
     end
 
-    # delegate to context
+    # Check both the context and the object before passing exception along
+    # @return [Method, StandardError]
     def method_missing(method, *args, &block)
       @context.send(method, *args, &block) if @context.respond_to?(method)
       @object.send(method, *args, &block) if @object.respond_to?(method)

data/lib/adorn/cache.rb

@@ -1,13 +1,27 @@
-require 'adorn/middleware'
-require 'adorn/railtie' if defined?(Rails::Railtie)
-
+# A threadsafe (on write), cache for storing objects during the request response cycle.
+# User responsibility to provide a serialization | deserialization strategy to set
+# get items from the hash.
+#
+# ex. setting data in Adorn::Cache can be acheieved like so:
+# Adorn::Cache.append!(:foo, serialized_object)
+#
+# ex. retrieving data in Adorn::Cache can be acheieved like so:
+# Adorn::Cache[:foo] #=> serialized_object
 module Adorn
   module Cache
     class << self
+      # Used to create a critical area during writes to Adorn::Cache
+      #
+      # @return [Mutex]
       def semaphore
         Thread.current[:semaphore] ||= Mutex.new
       end
 
+      # Instantiate or read from Adorn::Cache.
+      # Provide an interface to append to Adorn::Cache during request
+      #
+      # @param [Symbol, *]
+      # @return [Hash]
       def append!(key, value)
         Thread.current[:adorn_cache] ||= Hash.new
 
@@ -16,6 +30,25 @@ module Adorn
         end rescue nil #rescue ThreadError
       end
 
+      # Return value at given key from the Adorn::Cache.
+      #
+      # @param [Symbol, String]
+      # @return [Hash]
+      def [](key)
+        case key.class.to_s
+        when 'String'
+          Thread.current[:adorn_cache][key]
+        when 'Symbol'
+          Thread.current[:adorn_cache][key.to_s]
+        else
+          raise 'Unable to read key'
+        end
+
+      end
+
+      # Remove all values from the Adorn::Cache.
+      #
+      # @return [Hash]
       def clear!
         semaphore.synchronize do
           Thread.current[:adorn_cache].clear

data/lib/adorn/delegate.rb

@@ -1,6 +1,18 @@
+# Provides decorator descendants with the #extensions macro, which returns a module.
+# Useful for endowing decorated object with methods from modules
+# set the modules to extend the decorated object with the :with option.
+#
+# Adorn::Delegate.extensions { {with: [AwesomePower, GreatResponsibility]} }
+#
 module Adorn
   module Delegate
 
+    # Creates and anonymous module and passes the result of the given block
+    # back to the context, extending the named @object instance variable.
+    # Provide an interface to append to Adorn::Cache during request
+    #
+    # @param [Module, Object, Proc]
+    # @return [Module]
     def self.extensions(m=Module.new, context=self, &block)
       return unless block_given?
       m.instance_eval do

data/lib/adorn/display_context.rb

@@ -1,6 +1,8 @@
 module Adorn
   class DisplayContext
 
+    # @private
+    # @return [SimpleDelegator]
     def initialize(context)
       @context = SimpleDelegator.new(context)
     end

data/lib/adorn/helpers.rb

@@ -1,26 +1,35 @@
-# API: Use this method to present objects from the application to the view that require the presenter abstraction. The
-# method will accept single or multiple objects for dynamic presentation.
-#
-# Ex: Single Object, dynamic presenter loading
-# views/homes/foo.html.haml
-#
-# presenting @bar do |bar_presenter|
-#   responds to methods found in BarPresenter class
-# end
-#
-# Ex: Single Object, explicit Presenter Class
-#
-# presenting @bar, BazPresenter do |bar_presenter|
-#   responds to methods found in BazPresenter class
-# end
-#
-# Ex: Multiple Objects NOTE: implicit detection only
-#
-# presenting([@foo, @bar]) do |foo_presenter, bar_presenter|
-# end
 module Adorn
   module Helper
 
+    # A helper method to present objects with an implicit or explicilty set Adorn::Decorator
+    # Accepts single or multiple objects and Decorators for presentation.
+    #
+    # ex: Single Object, dynamic presenter loading
+    # presenting @bar do |bar_presenter|
+    #
+    #  bar_presenter will respond to methods from the BarPresenter
+    #
+    # end
+    #
+    # ex: Single Object, explicit Decorator Class
+    #
+    # presenting @bar, BazPresenter do |bar_presenter|
+    #
+    #  bar_presenter will respond to methods from the BazPresenter
+    #
+    # end
+    #
+    # ex: Multiple Objects NOTE: implicit detection only
+    #
+    # presenting([@foo, @bar]) do |foo_presenter, bar_presenter|
+    #
+    #  @foo will respond to methods from the FooPresenter
+    #  @bar will respond to methods from the BarPresenter
+    #
+    # end
+    #
+    # @param [Object, Class, Hash]
+    # @return [Adorn::Decorator]
     def presenting(object, klass=nil, options={})
       if object.is_a?(Array)
         object.each do |presentable|

data/lib/adorn/middleware.rb

@@ -1,4 +1,5 @@
 require 'adorn/cache'
+require 'adorn/railtie' if defined?(Rails::Railtie)
 
 module Adorn
   class Middleware

data/lib/adorn/object_decorator.rb

@@ -1,6 +1,8 @@
 module Adorn
   class ObjectDecorator
 
+    # @private
+    # @return [SimpleDelegator]
     def initialize(object)
       @object = SimpleDelegator.new(object)
     end

data/lib/adorn/presenter.rb

@@ -1,7 +1,29 @@
+# Provides interface for subclassing decorators. Methods on the decorated object will
+# be passed through the method that is defined using the ::presents method. Every object must
+# provide an object to decorate and a context object, options are passed through having no effect
+# on the presented object. The context object is implicit, when using the helper method #presenting
+# provided by Adorn::Helpers
+#
+# ex. Interface
+#
+# require 'adorn'
+# class WelcomePresernter < Adorn::Presenter
+#   Adorn::Delegate.extensions { {with: [ImportantModule, NeededBehavior]} }
+#
+#   presents :welcomer
+#
+#   def welcome
+#     welomer.english_greeting # => 'Hello there!'
+#   end
+# end
+
 module Adorn
   class Presenter < AbstractPresenter
     include Adorn::Delegate
 
+
+    #@param [Object, Object, Hash]
+    #@return [Adorn::Presenter]
     def initialize(*args)
       object, context, options = args
       @object                  = ObjectDecorator.new(object)

data/lib/adorn/version.rb

@@ -2,7 +2,7 @@ module Adorn
   module Version
     Major = 0
     Minor = 0
-    Tiny  = 4
+    Tiny  = 5
     Pre   = nil
 
     String = [Major, Minor, Tiny, Pre].compact.join(".")

data/test/test_adorn_cache.rb

@@ -4,7 +4,7 @@ require 'adorn/cache'
 
 ImportantObject = Struct.new(:name, :age) do
   def name
-    print "I am #{@name}"
+    print "my name is #{@name}"
   end
 
   def age
@@ -32,6 +32,18 @@ class TestAdornedCache < Adorn::TestCase
     assert_same me_or_someone_like_me, Thread.current[:adorn_cache]['person']
   end
 
+  def test_read_key
+    me_or_someone_like_me = ImportantObject.new('rhodee', 42)
+    Adorn::Cache.append! :person, me_or_someone_like_me
+
+    assert_same me_or_someone_like_me, Thread.current[:adorn_cache]['person']
+    assert_equal me_or_someone_like_me, Adorn::Cache[:person]
+  end
+
+  def test_read_unknown_key
+    assert_raises(NoMethodError) { Adorn::Cache[:unknown_key] }
+  end
+
   def test_clear_key
     another_person = ImportantObject.new('snuggs', 10)
     Adorn::Cache.append! :peep, another_person

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adorn
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - rhodee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-05 00:00:00.000000000 Z
+date: 2014-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard