king_placeholder 0.0.3 → 1.0.0

data/README.rdoc

@@ -1,10 +1,11 @@
 = KingPlaceholder
 {<img src="https://secure.travis-ci.org/salesking/king_placeholder.png?branch=master" alt="Build Status" />}[http://travis-ci.org/salesking/king_placeholder]
+
 This gem was extracted from SalesKing, where it does placeholders substitution
 for user supplied strings in Email-, Text- and Export-Templates.
 
 Placeholders are declared in each class and afterwards any strings containing
-[placeholders] can be parsed in the scope of the model.
+<b>[placeholders]</b> can be parsed in the scope of the model.
 
 Parsing is done by a simple statemachine using regex for placeholder detection.
 
@@ -16,7 +17,7 @@ Define the available methods in your class with 'has_placeholders'
     include KingPlaceholder
     has_many :comments
     has_one :company
-    has_placeholders :firstname, :email
+    has_placeholders :name, :email
   end
 
   class Comment
@@ -43,6 +44,33 @@ Handle relations
   @user.expand_placeholders("[company.name]")
   => MyCompany
 
+Set a custom formatting method(in format_placeholder) throught which all fields
+are run, if you have special money or date formatters.
+
+  class User
+    include KingPlaceholder
+    has_placeholders :created_at
+
+    def format_placeholder(field)
+      I18n.l( self.send(field) )
+    end
+  end
+
+Use callbacks to setup / teardown env variables
+
+  class User
+    include KingPlaceholder
+    has_placeholders :name, :email
+
+    def before_expand_placeholders
+      I18n.locale = self.language
+    end
+    def after_expand_placeholders
+      I18n.locale = nil
+    end
+  end
+
+
 Also see specs
 
 == TODO

data/king_placeholder.gemspec

@@ -18,9 +18,6 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'statemachine'
   gem.add_runtime_dependency 'i18n'
   gem.add_runtime_dependency 'activesupport'
-  gem.add_runtime_dependency 'actionpack'
-  #gem.add_runtime_dependency 'actionview'
-  #gem.add_runtime_dependency 'king_views'
 
   gem.add_development_dependency 'activerecord'
   gem.add_development_dependency 'rdoc'

data/lib/king_placeholder/parser.rb

@@ -1,8 +1,5 @@
 require 'statemachine'
-require 'action_view'       # king_views related suxs
-require 'action_controller' # king_views
-require 'king_views'
-
+require 'active_support/core_ext/string/inflections'
 module KingPlaceholder
   # Statemachine for placeholder substitution
   # The statemachine is created and its state updated from within the Context
@@ -31,7 +28,6 @@ module KingPlaceholder
   #   machine.sm.match
   #   machine.result
   class Parser
-    include ::KingFormat::FormattingHelper
     # reference to statemachine
     attr_accessor :sm
     # incoming string
@@ -53,13 +49,9 @@ module KingPlaceholder
       @opts = opts
     end
 
-    # Before matching is done this method set's up environment variables like
-    # current_language => i18n.locale
-    # TODO: decouple and outsource into before_method block to set env vars from outside
+    # Before matching is done deep copy content, because otherwise result.gsub!
+    # breaks recursion
     def prepare
-      init_locale  #I18n.locale
-      set_format_opts # merge date/money format into thread var
-      # deep copy content, because otherwise result.gsub! breaks recursion
       @result = @content.dup
     end
 
@@ -87,10 +79,8 @@ module KingPlaceholder
       @sm.finished_matching
     end
 
-    # When finished this method is called to cleanup f.ex. environment variables
-    # like I18n.locale
     def cleanup
-      @current_language && @current_language.reset_locale
+
     end
 
     private
@@ -99,7 +89,12 @@ module KingPlaceholder
     # namespace e.g. [price_to_pay]
     def sub_string
       return unless obj.is_placeholder?(@field)
-      value = strfval(obj, @field)
+      value = if @opts[:formatter]
+                obj.send(@opts[:formatter], @field)
+              else
+                obj.send @field
+              end
+      #value = strfval(obj, @field)
       @result.gsub!(@placeholder, value.to_s) if value
     end
 
@@ -162,44 +157,5 @@ module KingPlaceholder
       end
     end
 
-    # set format options for KingFormat date/money helpers
-    # => strfval + strfmoney
-    # very important, without those all formatting in views screws up
-    def set_format_opts
-      Thread.current[:default_currency_format] = if defined?(::Company) && ::Company.current
-        ::Company.current.money_format
-      elsif obj.respond_to?(:company) && obj.company
-        obj.company.money_format
-      elsif defined?(::Company) && obj.is_a?(::Company)
-        obj.money_format
-      else
-        nil
-      end
-
-      Thread.current[:default_date_format] = if defined?(::Company) && ::Company.current
-        ::Company.current.date_format
-      elsif obj.respond_to?(:company) && obj.company
-        obj.company.date_format
-      elsif defined?(::Company) && obj.is_a?(::Company)
-        obj.date_format
-      else
-        nil
-      end
-    end
-
-    # Set i18n.locale to given or present custom company locale
-    # locale is memoized in instance @current_language.
-    # Only set if a company and the language is available
-    # === Parameter
-    # locale<String>:: locale code en, de,..
-    def init_locale(locale=nil)
-      if (locale || (obj.respond_to?(:language) && obj.language)) \
-         && obj.respond_to?(:company) && obj.company
-        @current_language ||= begin
-          # find lang in scope of company
-          ::Language.init_locale(obj.company, locale || obj.language)
-        end
-      end
-    end
   end #class
 end #module

data/lib/king_placeholder/version.rb

@@ -1,3 +1,3 @@
 module KingPlaceholder
-  VERSION = "0.0.3"
+  VERSION = "1.0.0"
 end

data/lib/king_placeholder.rb

@@ -21,15 +21,33 @@ module KingPlaceholder
   end
 
   module ClassMethods
-    # Define fields(methods) available to placeholder substitution
+    # Define which fields(methods) are available to placeholder substitution.
+    #
+    # `before/after_expand_placeholders` hooks are run before the statemachine
+    # parsing. Define those methods to setup env variables like I18n.locale or
+    # whatever is required to format output strings.
+    # The block gets the current parsed object as method argument
+    # @example
+    #   def before_expand_placeholders
+    #     I18n.locale = self.language
+    #   end
+    #   def after_expand_placeholders
+    #     I18n.locale = nil
+    #   end
+    #
     # @param [Array[<Symbol>] fieldnames
     def has_placeholders(*fieldnames)
       self.placeholders = fieldnames
+      include ActiveSupport::Callbacks
+      define_callbacks :expand_placeholders
+      set_callback :expand_placeholders, :before, :before_parsing
+      set_callback :expand_placeholders, :after, :after_parsing
       include InstanceMethods
     end
   end
 
   module InstanceMethods
+
     # Check if a given field is declared as placeholder
     # @param [Object] fieldname to search in placeholders array
     # @return [Boolean]true if available
@@ -87,20 +105,31 @@ module KingPlaceholder
     # @param [Object] opts - unused for now
     # @return [Hash|Array|String] whatever type you throw in is also returned
     def expand_placeholders(content, opts={})
-      if content.is_a?(Array) # Expand all array elements and go recursive
+      if content.is_a?(Array)
         result = []
         content.each{|element| result << self.expand_placeholders(element, opts) }
         return result
-      elsif content.is_a?(Hash) # Expand all hash elements and go recursive
+      elsif content.is_a?(Hash)
         result = {}
         content.each_pair{ |key,val| result[key] = self.expand_placeholders(val, opts) }
         return result
       else # Only proceed with strings
         return content unless content.is_a?(String)
       end
-      parser = KingPlaceholder::Parser.new(self, content, opts)
-      parser.sm.match
-      parser.result if parser.sm.state == :finished
+      run_callbacks :expand_placeholders do
+        opts[:formatter] = :format_placeholder if self.respond_to?(:format_placeholder)
+        parser = KingPlaceholder::Parser.new(self, content, opts)
+        parser.sm.match
+        parser.result if parser.sm.state == :finished
+      end
     end
+
+    protected
+      def before_parsing
+        before_expand_placeholders if self.respond_to?(:before_expand_placeholders)
+      end
+      def after_parsing
+        after_expand_placeholders if self.respond_to?(:after_expand_placeholders)
+      end
   end # instance methods
 end # KingPlaceholders

data/spec/king_placeholder_spec.rb

@@ -18,39 +18,47 @@ end
 
 class Detail
   include KingPlaceholder
-  include KingFormat::MoneyFields
   attr_accessor :int_field, :money_field, :secret_field, :currency
   attr_accessor :master
-  has_money_fields :money_field
   has_placeholders :int_field, :money_field
 end
 
 describe 'Class with placeholders' do
 
   before :each do
-    I18n.locale = :en_master
-#    Thread.current[:default_currency_format] = I18n.t(:'number.currency.format')
     @record = Detail.new
-    @record.int_field = 1000
-    @record.money_field = 12.34
+    @record.int_field = 1002
+    @record.money_field = 12.333
   end
 
   it 'should have native values' do
-    @record.int_field.should == 1000
-    @record.money_field.should == 12.34
+    @record.int_field.should == 1002
+    @record.money_field.should == 12.333
   end
 
-  it 'should have placeholder values' do
-    @record.expand_placeholders('[int_field]').should == '1000'
-    @record.expand_placeholders('[money_field]').should == '$12.34'
+  it 'should have placeholder value' do
+    @record.expand_placeholders('[int_field]').should == '1002'
+    @record.expand_placeholders('[money_field]').should == '12.333'
   end
-
+  it 'should expand placeholders in an array' do
+    @record.expand_placeholders(['[int_field]', '[money_field]', 'static']).should == ['1002', '12.333', 'static']
+   end
+
+   it 'should expand placeholders in a hash' do
+     @record.expand_placeholders( :key1 => '[int_field]',
+                                   :key2 => '[money_field]',
+                                   :key3 => 'static'
+                                 ).should ==
+                                   { :key1 => '1002',
+                                     :key2 => '12.333',
+                                     :key3 => 'static' }
+   end
 end
 
-describe 'Expanding of strings containing placeholder' do
+describe 'Placeholder substitution' do
 
   before :each do
-    I18n.locale = :en_master
+    I18n.locale = :en
     @side = Side.new
     @side.field = 123
     @master = Master.new
@@ -72,100 +80,94 @@ describe 'Expanding of strings containing placeholder' do
     @master.details = [@detail1, @detail2]
   end
 
-  it 'should expand placeholders with no placeholders there' do
-    @detail1.expand_placeholders('without placeholder').should == 'without placeholder'
-    @detail1.expand_placeholders('[]').should == '[]'
-    @detail1.expand_placeholders('').should == ''
-    @detail1.expand_placeholders(nil).should == nil
-    @detail1.expand_placeholders("\n").should == "\n"
-  end
-
-  it 'should expand placeholders with simple fieldname' do
-    @detail1.expand_placeholders('[int_field]').should == '1001'
-    @detail1.expand_placeholders("[int_field]\n").should == "1001\n"
-    @detail1.expand_placeholders('[int_field]---[int_field]').should == '1001---1001'
-    @detail1.expand_placeholders('[int_field]---[money_field]').should == '1001---$12.34'
-  end
+  context 'with direct lookup' do
 
-  it 'should not expand placeholder for secret field' do
-    @detail1.expand_placeholders('[secret_field]').should == 'UNKNOWN for Detail: secret_field'
-  end
+    it 'should return without placeholders' do
+      @detail1.expand_placeholders('without placeholder').should == 'without placeholder'
+      @detail1.expand_placeholders('[]').should == '[]'
+      @detail1.expand_placeholders('').should == ''
+      @detail1.expand_placeholders(nil).should == nil
+      @detail1.expand_placeholders("\n").should == "\n"
+    end
 
-  it 'should expand placeholder with namespaced fieldname' do
-    @detail1.expand_placeholders('[master.string_field]').should == 'foo'
-    @detail1.expand_placeholders('[master.string_field] [int_field]').should == 'foo 1001'
-  end
+    it 'should expand with simple fieldname' do
+      @detail1.expand_placeholders('[int_field]').should == '1001'
+      @detail1.expand_placeholders("[int_field]\n").should == "1001\n"
+      @detail1.expand_placeholders('[int_field]---[int_field]--[money_field]').should == '1001---1001--12.34'
+    end
 
-  it 'should expand placeholder with namespaced to self fieldname' do
-    @detail1.expand_placeholders('[detail.int_field]').should == '1001'
-    @detail1.expand_placeholders('[detail.master.string_field] [detail.int_field]').should == 'foo 1001'
-  end
+    it 'should not parse unknown field' do
+      @detail1.expand_placeholders('[secret_field]').should == 'UNKNOWN for Detail: secret_field'
+    end
 
-  it 'should expand with multiple steps' do
-    @detail1.expand_placeholders('[master.side.field]').should == '123'
-  end
+    it 'should expand placeholder with not existing namespaces' do
+      @detail1.expand_placeholders('[nothing.string_field]').should == 'UNKNOWN for Detail: nothing.string_field'
+    end
 
-  it 'should expand placeholder with not existing namespaces' do
-    @detail1.expand_placeholders('[nothing.string_field]').should == 'UNKNOWN for Detail: nothing.string_field'
+    it 'should expand placeholder with wrong namespaces' do
+      @detail1.expand_placeholders('[master.this.are.too.much.namespaces]').should == 'UNKNOWN for Master: this.are.too.much.namespaces'
+      @detail1.expand_placeholders('[this.are.too.much.namespaces]').should == 'UNKNOWN for Detail: this.are.too.much.namespaces'
+      @detail1.expand_placeholders('[...]').should == 'UNKNOWN for Detail: ...'
+      @detail1.expand_placeholders('[unknown]').should == 'UNKNOWN for Detail: unknown'
+    end
   end
 
-  it 'should expand placeholder with wrong namespaces' do
-    @detail1.expand_placeholders('[master.this.are.too.much.namespaces]').should == 'UNKNOWN for Master: this.are.too.much.namespaces'
-    @detail1.expand_placeholders('[this.are.too.much.namespaces]').should == 'UNKNOWN for Detail: this.are.too.much.namespaces'
-    @detail1.expand_placeholders('[...]').should == 'UNKNOWN for Detail: ...'
-    @detail1.expand_placeholders('[unknown]').should == 'UNKNOWN for Detail: unknown'
-  end
+  context 'with namespace' do
 
-  it 'should expand placeholder group' do
-    @master.expand_placeholders('[details][int_field]\n[/details]').should == '1001\n1002\n'
-    @master.expand_placeholders('[details]Test:[int_field][/details]').should == 'Test:1001Test:1002'
-    @master.expand_placeholders("[details][int_field]\n[/details]").should == "1001\n1002\n"
+    it 'should parse referenced object fields' do
+      @detail1.expand_placeholders('[master.string_field]').should == 'foo'
+      @detail1.expand_placeholders('[master.string_field] [int_field]').should == 'foo 1001'
+    end
 
-    @master.expand_placeholders('[details][foo][/details]').should == 'UNKNOWN for Detail: fooUNKNOWN for Detail: foo'
-  end
+    it 'should parse self referenced field' do
+      @detail1.expand_placeholders('[detail.int_field]').should == '1001'
+      @detail1.expand_placeholders('[detail.master.string_field] [detail.int_field]').should == 'foo 1001'
+    end
 
-  it 'should expand valid but empty placeholder group with empty string' do
-    master = Master.new
-    master.details = []
-    master.expand_placeholders('[details][int_field][/details]').should == ''
+    it 'should parse multiple steps' do
+      @detail1.expand_placeholders('[master.side.field]').should == '123'
+    end
   end
 
-  it 'should expand single item from a placeholder group' do
-    @master.details.inspect
-    @master.expand_placeholders('[details.1.int_field]').should == '1001'
-    @master.expand_placeholders('[details.2.int_field]').should == '1002'
+  context 'with empty fields' do
+    it 'should expand valid but empty placeholder group with empty string' do
+      master = Master.new
+      master.details = []
+      master.expand_placeholders('[details][int_field][/details]').should == ''
+    end
+    it 'should expand single item group with empty string' do
+      @master.expand_placeholders('[details.10.int_field]').should == ''
+    end
   end
 
-  it 'should expand single item in empty placeholder group with empty string' do
-    master = Master.new
-    master.details  = []
-    master.expand_placeholders('[details.0.int_field]').should == ''
-  end
+  context 'with collection' do
+    it 'should expand' do
+      @master.expand_placeholders('[details][int_field]\n[/details]').should == '1001\n1002\n'
+      @master.expand_placeholders('[details]Test:[int_field][/details]').should == 'Test:1001Test:1002'
+      @master.expand_placeholders("[details][int_field]\n[/details]").should == "1001\n1002\n"
+      @master.expand_placeholders('[details][foo][/details]').should == 'UNKNOWN for Detail: fooUNKNOWN for Detail: foo'
+    end
 
-  it 'should expand empty single item from placeholder group with empty string' do
-     @master.expand_placeholders('[details.10.int_field]').should == ''
-  end
+    it 'should expand single item ' do
+      @master.expand_placeholders('[details.1.int_field]').should == '1001'
+      @master.expand_placeholders('[details.2.int_field]').should == '1002'
+    end
 
-  it 'should expand placeholder group for non ending group' do
-    @master.expand_placeholders('[details][int_field]').should == 'END MISSING FOR detailsUNKNOWN for Master: int_field'
+    it 'should show error for missing closing' do
+      @master.expand_placeholders('[details][int_field]').should == 'END MISSING FOR detailsUNKNOWN for Master: int_field'
+    end
   end
 
-  # TODO: Make this possible!
-#   it "should expand placeholder group if referenced with namespace" do
-#       @master.expand_placeholders("[master.details][int_field][end]").should == "10011002"
-#   end
+  context 'with custom formatter' do
+    before :each do
+      I18n.locale = :en_master
+    #    Thread.current[:default_currency_format] = I18n.t(:'number.currency.format')
+    end
 
-  it 'should expand placeholders in an array' do
-    @detail1.expand_placeholders(['[int_field]', '[money_field]', 'static']).should == ['1001', '$12.34', 'static']
+    xit 'should format money' do
+      @record.expand_placeholders('[money_field]').should == '$12.34'
+    end
   end
 
-  it 'should expand placeholders in a hash' do
-    @detail1.expand_placeholders( :key1 => '[int_field]',
-                                  :key2 => '[money_field]',
-                                  :key3 => 'static'
-                                ).should ==
-                                  { :key1 => '1001',
-                                    :key2 => '$12.34',
-                                    :key3 => 'static' }
-  end
+
 end

data/spec/spec_helper.rb

@@ -1,20 +1,16 @@
 # encoding: utf-8
 $:.unshift(File.dirname(__FILE__))
 $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-ENV["RAILS_ENV"] ||= 'test'
 
 require 'simplecov'
 SimpleCov.start do
-  add_filter "/json/"
+  #add_filter "/json/"
 end
 SimpleCov.coverage_dir 'coverage'
 
-require 'rubygems'
 require 'rspec'
 require 'active_record'
 require 'king_placeholder'
 
-
-
 RSpec.configure do |config|
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: king_placeholder
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-28 00:00:00.000000000 Z
+date: 2012-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: statemachine
@@ -59,22 +59,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: actionpack
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -189,7 +173,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2706534140845333133
+      hash: 3312225675603911462
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -198,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2706534140845333133
+      hash: 3312225675603911462
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24