florrick 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 20ab91439eaf4ce4d05675e501a0667f48138633
+  data.tar.gz: 0df8702cce5af859de517f3e34a645608aa9b993
+SHA512:
+  metadata.gz: df6f287a92029579b87b8589e140792ed7f747464666718ab2e177fa7a40b91eff1a7dc03aa5b13799a6a668394f89fef60ec8f79cf3f4489901b82adefca782
+  data.tar.gz: 64a594f1d4b80a821f09117b340c11ac4ce91d72c85d0014cc7193898be33e7cb57c13991f68ed62e9c43271d2d279e2c7001246870e7710e2cab3c1149aed54

data/lib/florrick/active_record_extension.rb

@@ -0,0 +1,55 @@
+module Florrick
+  module ActiveRecordExtension
+    
+    def self.included(base)
+      base.extend ClassMethods
+    end
+    
+    def string_interpolation_value_for(var)
+      if self.class.florrick_fields[:strings].keys.include?(var.to_sym)
+        block = self.class.florrick_fields[:strings][var.to_sym]
+        if block
+          self.instance_eval(&block)
+        else
+          self.send(var)
+        end
+      else
+        false
+      end
+    end
+    
+    module ClassMethods
+
+      #
+      # Return a hash for all florrick fields which have been defined for this model
+      #
+      def florrick_fields
+        @florrick_fields ||= {:strings => {}, :relationships =>{}}
+      end
+      
+      #
+      # Accept a new set of configuration for this model
+      #
+      def florrick(&block)
+        dsl = Florrick::DSL.new(self)
+        dsl.instance_eval(&block)
+        dsl
+      end
+      
+      #
+      # Return whether or not a given key can be replaced
+      #
+      def string_interpolation_for?(var)
+        florrick_fields[:strings].keys.include?(var.to_sym)
+      end
+      
+      #
+      # Return whether or not a given relationship key can be replaced 
+      #
+      def string_interpolation_relationship_for?(var)
+        florrick_fields[:relationships].keys.include?(var.to_sym)
+      end
+    end
+    
+  end
+end

data/lib/florrick/builder.rb

@@ -0,0 +1,60 @@
+module Florrick
+  class Builder
+    
+    VALID_EXPORT_TYPES = [String, Numeric, Date, Time]
+    
+    attr_reader :original_string, :objects
+
+    def initialize(string, objects = {})
+      @original_string = string
+      @objects = objects
+    end
+
+    def output
+      string = @original_string.dup
+      string.gsub(/(\{\{([(\w+)\.]+)\}\})/) do
+        parts = $2.split('.')
+        final_string = nil
+        previous_object = @objects[parts.shift.to_sym]
+        final_string = $1 if previous_object.nil?
+        until final_string
+          # get the latest part
+          if var = parts.shift
+            # if the previous object is suitable for string interpolation, we can 
+            # pass the var to it and get out a string or an integer.
+            if previous_object.respond_to?(:string_interpolation_value_for)
+              if previous_object.class.string_interpolation_for?(var)
+                # we can do this easily
+                previous_object = previous_object.string_interpolation_value_for(var)
+                # if the previous object was nil, just set to an empty string
+                final_string = "" if previous_object.nil?
+              elsif previous_object.class.string_interpolation_relationship_for?(var)
+                # maybe we can do this on another object
+                previous_object = previous_object.send(var)
+              else
+                # can't do this :(
+                final_string = $1
+              end
+            elsif VALID_EXPORT_TYPES.any? { |t| previous_object.is_a?(t)}
+              previous_object = Florrick::Formatter.convert(var, previous_object)
+            else
+              # does not respond to string_interpolation_value_for and isn't a valid object,
+              # we can't do anything here just return the passed value.
+              final_string = $1
+            end
+          else
+            # we're at the end now, if we can return the previous object, lets do it otherwise
+            # we'll just return the string as we can't do anything.
+            if VALID_EXPORT_TYPES.any? { |t| previous_object.is_a?(t)}
+              final_string = previous_object.to_s
+            else
+              final_string = $1
+            end
+          end
+        end
+        final_string
+      end
+    end
+
+  end
+end

data/lib/florrick/builtin_formatters.rb

@@ -0,0 +1,39 @@
+# This file contains all formatters which are built-in. Some of these built-in formatters
+# require ActiveSupport but seeing as that's a dependency of ActiveRecord, it won't be a problem
+# for most users.
+require 'active_support/core_ext/integer/inflections'
+require 'active_support/inflector/transliterate'
+require 'digest/sha1'
+require 'digest/md5'
+
+#
+# String formatters
+#
+Florrick::Formatter.add('downcase', [String]) { |s| s.downcase }
+Florrick::Formatter.add('upcase', [String]) { |s| s.upcase }
+Florrick::Formatter.add('humanize', [String]) { |s| s.humanize }
+Florrick::Formatter.add('strip', [String]) { |s| s.strip }
+Florrick::Formatter.add('sha1', [String]) { |s| Digest::SHA1.hexdigest(s) }
+Florrick::Formatter.add('md5', [String]) { |s| Digest::MD5.hexdigest(s) }
+
+#
+# Mathmatical formatters
+#
+Florrick::Formatter.add('double', [Numeric]) { |s| s * 2 }
+Florrick::Formatter.add('triple', [Numeric]) { |s| s * 3 }
+
+#
+# DateTime formatters
+#
+
+Florrick::Formatter.add('long_date', [Date, Time]) { |s| s.strftime("%A #{s.day.ordinalize} %B %Y") }
+Florrick::Formatter.add('long_date_without_day_name', [Date, Time]) { |s| s.strftime("#{s.day.ordinalize} %B %Y") }
+
+Florrick::Formatter.add('short_date', [Date, Time]) { |s| s.strftime("%a %e %b %Y") }
+Florrick::Formatter.add('short_date_without_day_name', [Date, Time]) { |s| s.strftime("%e %b %Y") }
+
+Florrick::Formatter.add('ddmmyyyy', [Date, Time]) { |s| s.strftime("%d/%m/%Y") }
+Florrick::Formatter.add('hhmm', [Date, Time]) { |s| s.strftime("%H:%M") }
+Florrick::Formatter.add('hhmmss', [Date, Time]) { |s| s.strftime("%H:%M:%S") }
+Florrick::Formatter.add('hhmm12', [Date, Time]) { |s| s.strftime("%I:%M%P") }
+Florrick::Formatter.add('hhmmss12', [Date, Time]) { |s| s.strftime("%I:%M:%S%P") }

data/lib/florrick/dsl.rb

@@ -0,0 +1,20 @@
+module Florrick
+  class DSL
+    
+    def initialize(model)
+      @model = model
+    end
+    
+    def string(*vars, &block)
+      vars.each do |var|
+        @model.florrick_fields[:strings][var.to_sym] = block
+      end
+    end
+    
+    def relationship(*vars, &block)
+      vars.each do |var|
+        @model.florrick_fields[:relationships][var.to_sym] = block
+      end
+    end
+  end
+end

data/lib/florrick/formatter.rb

@@ -0,0 +1,40 @@
+module Florrick
+  class Formatter
+    
+    class << self
+      # Return all formatters available
+      def formatters
+        @formatters ||= {}
+      end
+      
+      # Add a new global formatter
+      def add(name, types = [], &block)
+        formatters[name.to_sym] = self.new(name, types, &block)
+      end
+      
+      # Run a string through a given formatter and return the result. If not possible, return false.
+      def convert(name, value)
+        if formatter = formatters[name.to_sym]
+          formatter.convert(value)
+        else
+          false
+        end
+      end
+    end
+    
+    def initialize(name, types, &block)
+      @name, @types, @block = name, types, block
+    end
+    
+    def convert(value)
+      if @types.empty? || @types.any? { |t| value.is_a?(t)}
+        @block.call(value)
+      else
+        false
+      end
+    rescue
+      '???'
+    end
+    
+  end
+end

data/lib/florrick/railtie.rb

@@ -0,0 +1,12 @@
+module Florrick
+  class Railtie < Rails::Railtie
+    
+    initializer 'florrick.initialize' do
+      ActiveSupport.on_load(:active_record) do
+        require 'florrick/active_record_extension'
+        ActiveRecord::Base.send :include, Florrick::ActiveRecordExtension
+      end
+    end
+    
+  end
+end

data/lib/florrick/version.rb

@@ -0,0 +1,3 @@
+module Florrick
+  VERSION = '1.0.0'
+end

data/lib/florrick.rb

@@ -0,0 +1,15 @@
+require 'florrick/version'
+require 'florrick/builder'
+require 'florrick/dsl'
+require 'florrick/formatter'
+require 'florrick/builtin_formatters'
+require 'florrick/railtie' if defined?(Rails)
+
+module Florrick
+  
+  # A quick helper method for quickly running conversion
+  def self.convert(string, objects = {})
+    Builder.new(string, objects).output
+  end
+  
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: florrick
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Adam Cooke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-02 00:00:00.000000000 Z
+dependencies: []
+description: A Rails extension for providing awesome user-initiated string interpolation
+email:
+- me@adamcooke.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/florrick.rb
+- lib/florrick/active_record_extension.rb
+- lib/florrick/builder.rb
+- lib/florrick/builtin_formatters.rb
+- lib/florrick/dsl.rb
+- lib/florrick/formatter.rb
+- lib/florrick/railtie.rb
+- lib/florrick/version.rb
+homepage: https://github.com/adamcooke/florrick
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: A Rails extension for providing awesome user-initiated string interpolation
+test_files: []
+has_rdoc: