king_placeholder 1.0.3 → 2.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTlmYzAwNmNkYjhhN2RiZWUyMjhhYzNjNjJjOTlkMTU0NmQ5ZDYwMA==
+  data.tar.gz: !binary |-
+    NzI1YzYyNGI4ZmRiNWFhNDY1MWQ2YjJlZDQ3ODZlN2ZkYTE0ODA2Mg==
+SHA512:
+  metadata.gz: !binary |-
+    MmE3NmE3MzdiMGVmYmM1N2I1NTQwZTlkMGI1NTc3Yzc2NzMwN2UzOWI5ZDgw
+    ZGFhYTNlZmE3YTYwZmI3MjEwNThlODFlN2VlMjY3YThiNGU5YzgxNzFkYzUz
+    YzA1YTVlNzI1YTc4MWE1ZWFmNTdkNjliOTNjNDRiOWE3NWEyMmU=
+  data.tar.gz: !binary |-
+    ZTBmYzNhZGVhZDEwMGY4NzIwZjMxYWUzNmI3ZGZhMDQ5MDE3NTZiMWVkZjY4
+    NmU0MDRjNzQyYTRjNDQ2OTNmZGJjOGMwZjE2ZDhiM2I3Njg1ZmUyODBiYjgy
+    MjZjY2YzZjQ4OWVhZDZhNDg0Yjg3ZTBjMTM3NDcxY2JmZTI0MTQ=

data/README.rdoc

@@ -1,8 +1,8 @@
 = 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.
+This gem does simple [placeholders] substitution for user supplied strings in
+Email-, Text- and Export-Templates.
 
 Placeholders are declared in each class and afterwards any strings containing
 <b>[placeholders]</b> can be parsed in the scope of the model.
@@ -75,9 +75,7 @@ Also see specs
 
 == TODO
 
-This gems still relies on gem king_views with king_format, for money, date
-formatting. We will outsource king_format into its own gem and remove more
-Rails and SalesKing internal dependencies.
+* make placeholder marks: [] brackets configurable
 
 == Installation
 

data/king_placeholder.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |gem|
   gem.version       = KingPlaceholder::VERSION
 
   gem.add_runtime_dependency 'statemachine'
-  gem.add_runtime_dependency 'activesupport'
+  gem.add_runtime_dependency 'activesupport', '>3.0'
 
   gem.add_development_dependency 'activerecord'
   gem.add_development_dependency 'rdoc'

data/lib/king_placeholder.rb

@@ -11,11 +11,7 @@ module KingPlaceholder
   include ActiveSupport::Callbacks
 
   included do
-    if ActiveSupport::VERSION::MAJOR == 3 && ActiveSupport::VERSION::MINOR > 0
-      class_attribute :placeholders
-    else
-      class_inheritable_accessor :placeholders
-    end
+   class_attribute :placeholders
     placeholders = []
   end
 
@@ -44,91 +40,87 @@ module KingPlaceholder
     end
   end
 
-  # TODO inclusion deprecated in ActiveSupport 3.2.7, when gone move methods up into module
-  module InstanceMethods
+  # Check if a given field is declared as placeholder
+  # @param [Object] fieldname to search in placeholders array
+  # @return [Boolean]true if available
+  def is_placeholder?(fieldname)
+    self.class.placeholders.include?(fieldname.to_sym)
+  end
 
-    # Check if a given field is declared as placeholder
-    # @param [Object] fieldname to search in placeholders array
-    # @return [Boolean]true if available
-    def is_placeholder?(fieldname)
-      self.class.placeholders.include?(fieldname.to_sym)
+  # Substitute placeholder in a string with their current values.
+  # It handles strings, arrays (of strings) or hashes (with string values)
+  # and returns data with the same data type e.g. if you put a hash, you will
+  # get a hash.
+  #
+  # @examples
+  #
+  # Placeholders in text strings can be written in different notations.
+  #
+  # === Simple Notation:
+  #
+  #  => [first_name]
+  # The fieldname is directly looked up on the current class:
+  # client.expand_placeholders("Hello [first_name]")
+  #   => "Hello Herbert"
+  # invoice.expand_placeholders(["You owe me [price_to_pay]", "Invoice Nr. [number]"])
+  #   => ["You owe me 495,00 EUR", "Invoice Nr. 123"]
+  #
+  # === Namespaced Notation
+  #
+  # => [company.organisation]
+  # If the prefix equals the type of the current object the field is looked up on it.
+  #   client.expand_placeholders("Hello [client.first_name]")
+  #   => "Hello Herbert"
+  #
+  # If the prefix is a single related object => Client :belongs_to Company,
+  # the substitution is delegated to that class.
+  #   client.expand_placeholders("Belongs to [company.name]")
+  #   => ""Belongs to Big Money Coorp."
+  # It goes down all the way:
+  #   invoice.expand_placeholders("[client.company.default_address.zip]")
+  #   => "50999"
+  #
+  # === Namespaced Notation with multiple related objects
+  #
+  # In a has_many relationship, related objects reside in an array, which can
+  # be reached using two different strategies.
+  #
+  # Access and Iterate over the whole Group:
+  #   invoice.expand_placeholders("You bought: [items] [name] [/items]")
+  #   => "You bought: Apple Banana Orange"
+  #
+  # Access a single object by its array index:
+  #   invoice.expand_placeholders("You bought an [items.0.name] for [items.0.price]")
+  #   => "You bought an Apple for 12 EUR"
+  #
+  # @param [Hash|Array|String] content with placeholders
+  # @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)
+      result = []
+      content.each{|element| result << self.expand_placeholders(element, opts) }
+      return result
+    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
-
-    # Substitute placeholder in a string with their current values.
-    # It handles strings, arrays (of strings) or hashes (with string values)
-    # and returns data with the same data type e.g. if you put a hash, you will
-    # get a hash.
-    #
-    # @examples
-    #
-    # Placeholders in text strings can be written in different notations.
-    #
-    # === Simple Notation:
-    #
-    #  => [first_name]
-    # The fieldname is directly looked up on the current class:
-    # client.expand_placeholders("Hello [first_name]")
-    #   => "Hello Herbert"
-    # invoice.expand_placeholders(["You owe me [price_to_pay]", "Invoice Nr. [number]"])
-    #   => ["You owe me 495,00 EUR", "Invoice Nr. 123"]
-    #
-    # === Namespaced Notation
-    #
-    # => [company.organisation]
-    # If the prefix equals the type of the current object the field is looked up on it.
-    #   client.expand_placeholders("Hello [client.first_name]")
-    #   => "Hello Herbert"
-    #
-    # If the prefix is a single related object => Client :belongs_to Company,
-    # the substitution is delegated to that class.
-    #   client.expand_placeholders("Belongs to [company.name]")
-    #   => ""Belongs to Big Money Coorp."
-    # It goes down all the way:
-    #   invoice.expand_placeholders("[client.company.default_address.zip]")
-    #   => "50999"
-    #
-    # === Namespaced Notation with multiple related objects
-    #
-    # In a has_many relationship, related objects reside in an array, which can
-    # be reached using two different strategies.
-    #
-    # Access and Iterate over the whole Group:
-    #   invoice.expand_placeholders("You bought: [items] [name] [/items]")
-    #   => "You bought: Apple Banana Orange"
-    #
-    # Access a single object by its array index:
-    #   invoice.expand_placeholders("You bought an [items.0.name] for [items.0.price]")
-    #   => "You bought an Apple for 12 EUR"
-    #
-    # @param [Hash|Array|String] content with placeholders
-    # @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)
-        result = []
-        content.each{|element| result << self.expand_placeholders(element, opts) }
-        return result
-      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
-      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
+    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
+  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 # KingPlaceholders

data/lib/king_placeholder/version.rb

@@ -1,3 +1,3 @@
 module KingPlaceholder
-  VERSION = "1.0.3"
+  VERSION = "2.0.0"
 end

data/spec/king_placeholder_spec.rb

@@ -150,7 +150,9 @@ describe 'Placeholder substitution' do
     it 'should parse empty related object with empty string' do
       @client.company = nil
       @client.expand_placeholders('[company.name]').should == ''
+      @client.expand_placeholders('[client.company.name]').should == ''
     end
+
   end
 
   context 'with collection' do

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: king_placeholder
 version: !ruby/object:Gem::Version
-  version: 1.0.3
-  prerelease: 
+  version: 2.0.0
 platform: ruby
 authors:
 - Georg Leciejewski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-01 00:00:00.000000000 Z
+date: 2015-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: statemachine
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -30,23 +27,20 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ! '>'
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ! '>'
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -94,7 +83,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -102,7 +90,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -110,7 +97,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -118,7 +104,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -145,33 +130,26 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/salesking/king_placeholder.git
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 961112527656133584
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 961112527656133584
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Placeholder Parsing in Strings
 test_files:
 - spec/king_placeholder_spec.rb