king_views 1.0.0

data/king_form/tasks/king_forms_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :king_forms do
+#   # Task goes here
+# end

data/king_form/test/king_forms_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class King-formsTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/king_form/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

data/king_format/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009-2010 Georg Leciejewski
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/king_format/README.rdoc

@@ -0,0 +1,20 @@
+= KingFormat
+KingFormat consists of two different formatting helper regions:
+
+== Model
+Define fields being of type date, money or percent.  When the fields are shown in the
+views, their format is detected and the output is looking nice.
+
+== View & Helper
+Output any model value through the function formatted_value() to ensure a consistent output.
+
+There are select values for money-symbols and date formatting.
+
+
+== Example
+In a Model
+  has_money_fields :amount
+  has_date_fields :subscription_start
+  has_percent_fields :tax
+
+Copyright (c) 2009 Georg Leciejewski, released under the MIT license

data/king_format/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the king_format plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the king_format plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'KingFormat'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/king_format/init.rb

@@ -0,0 +1 @@
+require "#{File.dirname(__FILE__)}/lib/king_format"

data/king_format/lib/helpers/date_helper.rb

@@ -0,0 +1,25 @@
+module KingFormat
+  # Provides some helper functions for action controller /  view
+  module DateHelper
+
+    # define date formats to be used in date date_format_select
+    DATE_FORMATS = [
+                    '%Y-%m-%d',
+                    '%d/%m/%Y',
+                    '%d.%m.%Y',
+                    '%d-%m-%Y',
+                    '%m/%d/%Y',
+#                    '%d %b %Y',
+#                    '%d %B %Y',
+#                    '%b %d, %Y',
+#                    '%B %d, %Y'
+                      ]
+
+
+    # Default date formats to be used in select boxes => choices in rails select helper
+    def date_format_options
+      DATE_FORMATS.collect {|f| ["#{Date.today.strftime(f)} - #{f}", f]}
+    end
+    
+  end
+end

data/king_format/lib/helpers/formatting_helper.rb

@@ -0,0 +1,108 @@
+module KingFormat
+  # General Helper Functions to auto-format an output
+  module FormattingHelper
+
+    include ActionView::Helpers::NumberHelper
+    # Get a nice formatted string for an object attribute value.
+    #
+    # ==== Parameters
+    # object<Object>:: The object on which the given fieldname will be called => object.send(fieldname), to get the value
+    # fieldname<String>:: Name of the field for which to get a value
+    # value<String|Symbol|Date|FalseClass|TrueClass|...>::The value to display. When set this will be used instead of asking the object for its value.
+    # See types for more
+    # opts<Hash{Symbol=>String}>:: Options
+    #  
+    # ==== Options opts
+    #  currency<Hash{Symbol=>String}>:: Currency settings to format string as a money like found in rails I18n. or see rails number_helper.
+    #  When set, object AND fieldname must be set and the field must be in money_fields (via: has_money_fields)
+    #  Alternatively you can call the method with currency options set which will also lead to money rendering
+    #  format -> defaults to :html returned html string has escaped html entities
+    #
+    #
+    # ==== AutoDetect Types
+    # A value is formatted according to its type which we try to detect.
+    #   <Symbol>:: assume a value from acts_as_enum
+    #   <DateTime|Time|Date>::I18n.localize -> l(value)
+    #   <TrueClass|FalseClass>:: translate to yes / no
+    #   <MoneyField String>:: coming from a has_percent_fields, formats the number with number_to_percentage_auto_precision
+    #   <PercentField String>:: comming from has_money_fields I18n formats as money string
+    #
+    def formatted_value(object, fieldname, value=nil, opts={})
+      # If no value given, call fieldname on object to get the current value
+      value ||= if object.respond_to?(fieldname)
+        object.send(fieldname) || '' #return the content or if no content an empty string
+      else #field is not available in object
+        nil
+      end
+
+      # Autodetect value type
+      if value.nil?
+        nil
+
+      elsif value.is_a?(Symbol) # enum value from acts_as_enum
+        translated_enum_value(object, fieldname, value)
+      elsif value.is_a?(DateTime) || value.is_a?(Time)  #|| value.is_a?(Date)
+        I18n.localize(value)
+      elsif value.is_a?(TrueClass) || value.is_a?(FalseClass)
+        value ? t(:'sk.yes') : t(:'sk.no')
+      elsif (object.class.is_percent_field?(fieldname) rescue nil)
+        (value && !value.blank?) ? number_to_percentage_auto_precision(value) : ''
+      elsif (object.class.is_money_field?(fieldname) rescue nil) || opts[:currency] # field is defined as money field OR currency options are passed in
+        # get currency from opts or company or fallback into i18n
+        settings = opts[:currency] || default_currency_format
+        # display with a rounding of 2 despite precision defined in company settings .. quick and dirty
+        #  .. other option would be to define such in has_money_fields via method missing or so 
+        if fieldname.to_s[/_round$/] # invoice.price_total_round
+          settings[:precision] = 2
+        end
+        number_to_currency(value, settings.merge({:locale => I18n.locale}))
+      elsif ( value.is_a?(Date) || (object.class.is_date_field?(fieldname) rescue nil) || opts[:date] ) #field is defined as date field OR date options are passed in
+        return value if value.blank? # blank value can occur when a is_date_field is empty
+          # get date from opts or company or fallback into i18n
+          format = opts[:date] || default_date_format
+          format.blank? ? ::I18n.localize(value) : value.strftime(format)
+      else
+       if opts[:format] == :html
+          # Change HTML tag characters to entities
+          ERB::Util.html_escape(value)
+        else
+          value
+        end
+      end
+    end #formatted
+
+    # Returns the default date formatting.
+    # The returned string is passed to strftime(format)
+    # === Returns
+    # <String>:: strftime compatible string
+    def default_date_format
+      Company.current.date_format rescue nil
+    end
+
+    # Returns the default currency formatting.
+    # The returned hash is used in rails number_to_currency helper
+    # === Returns
+    # <Hash>:: number_to_currency compatible options hash
+    def default_currency_format
+      Company.current.currency rescue {}
+    end
+
+    # Formats a number to the visible decimal places if there are more than the
+    # given prescision
+    # 
+    # ====Parameter
+    # number<Float>:: The number to format
+    # precs<Integer>:: The precision to which to round the number
+    # ==== Return
+    # nil if number is nil
+    # <String> with formatted number
+    def money_auto_precision(number, precs)
+      return unless number
+      decimals = number.to_s[/\.(.*)\z/, 1] #15.487 => 487
+      precision = (decimals && decimals.length > precs) ? decimals.length : precs
+      rounded_number = (Float(number) * (10 ** precision)).round.to_f / 10 ** precision
+      "%01.#{precision}f" % rounded_number
+    end
+
+  end # FormattingHelper
+end # KingFormat

data/king_format/lib/helpers/money_helper.rb

@@ -0,0 +1,63 @@
+module KingFormat
+  # a little rewrite of the rails internal number helper with better:
+  # - rounding
+  # - detecting money symbol / money string
+  # -
+  module MoneyHelper
+
+    # returns the keys from money symbols als Hash{array} for select options 
+    def money_selects
+      money_symbols.keys.sort
+    end
+
+    # ==== Returns
+    # Hash with currency as keys and formatting options as sub hash
+    # { 'EUR' => {:unit=>'€', :format => '%n %u', :precision=> '2',:delimiter=>'.', :separator=>','},
+    #   'USD' => {:unit=>'$'}
+    def money_symbols
+      @money_symbols ||= begin
+        eur = {:format => '%n %u', :precision=> '2',:delimiter=>'.', :separator=>','}
+        dol = {:format => '%n %u', :precision=> '2',:delimiter=>',', :separator=>'.'}
+        {
+        'EUR' => eur.merge(:unit=>'€'),
+        'GBP' => dol.merge(:unit=>'£'),
+        'JPY' => dol.merge(:unit=>'¥'),
+        'USD' => dol.merge(:unit=>'$'),
+        'AUD' => dol.merge(:unit=>'$'),
+        'CAD' => dol.merge(:unit=>'$'),
+        'HKD' => dol.merge(:unit=>'$'),
+        'SGD' => dol.merge(:unit=>'$'),
+        'AED' => nil,
+        'BGN' => nil,
+        'CZK' => nil,
+        'DKK' => nil,
+        'EEK' => nil,
+        'HUF' => nil,
+        'LTL' => nil,
+        'LVL' => nil,
+        'PLN' => nil,
+        'RON' => nil,
+        'SEK' => nil,
+        'SKK' => nil,
+        'CHF' => nil,
+        'ISK' => nil,
+        'NOK' => nil,
+        'HRK' => nil,
+        'RUB' => nil,
+        'TRY' => nil,
+        'BRL' => nil,
+        'CNY' => nil,
+        'IDR' => nil,
+        'KRW' => nil,
+        'MXN' => nil,
+        'MYR' => nil,
+        'NZD' => nil,
+        'PHP' => nil,
+        'THB' => nil,
+        'ZAR' => dol.merge(:unit=>'R')
+      }
+      end
+    end
+   
+  end
+end

data/king_format/lib/king_format.rb

@@ -0,0 +1,14 @@
+# KingFormat
+$LOAD_PATH << File.expand_path(File.dirname(__FILE__))
+
+# AR model extension to define money / percent fields
+require 'model_mixins/has_percent_fields'
+require 'model_mixins/has_money_fields'
+require 'model_mixins/has_date_fields'
+
+require 'helpers/formatting_helper'
+ActionController::Base.helper KingFormat::FormattingHelper
+require 'helpers/date_helper' # holding date functions
+ActionController::Base.helper KingFormat::DateHelper
+require 'helpers/money_helper' # holding money symbols
+ActionController::Base.helper KingFormat::MoneyHelper

data/king_format/lib/model_mixins/has_date_fields.rb

@@ -0,0 +1,42 @@
+module KingFormat
+  module DateFields
+
+    def self.included(base)
+      base.send :class_inheritable_accessor, :date_fields
+      base.date_fields = []
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      #  Defines the fields returned by self.date_fields.
+      # ===== Parameter
+      # fieldnames<Array[Symbol]>:: fieldnames/instance method names as symbols
+      # ==== Example
+      # class Invoice
+      #   has_date_fields :total, :amout, :calculated_tax
+      #
+      def has_date_fields(*fieldnames)
+        self.date_fields = fieldnames
+        include InstanceMethods
+      end
+
+      # Check if a given field is declared as date field
+      # ==== Parameter
+      # fieldname<String>:: The fieldname to check. Is be casted into a symbol.
+      def is_date_field?(fieldname)
+        self.date_fields.include?(fieldname.to_sym)
+      end
+
+    end #ClassMethods
+
+    module InstanceMethods
+      # Check if a given field is declared as date field
+      # ==== Parameter
+      # fieldname<String>:: The fieldname to check. Is be casted into a symbol.
+      def is_date_field?(fieldname)
+        self.class.date_fields.include?(fieldname.to_sym)
+      end
+    end
+    
+  end #Fields
+end#KingFormat

data/king_format/lib/model_mixins/has_money_fields.rb

@@ -0,0 +1,42 @@
+module KingFormat
+  module MoneyFields
+
+    def self.included(base)
+      base.send :class_inheritable_accessor, :money_fields
+      base.money_fields = []
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      #  Defines the fields returned by self.money_fields.
+      # ===== Parameter
+      # fieldnames<Array[Symbol]>:: fieldnames/instance method names as symbols
+      # ==== Example
+      # class Invoice
+      #   has_money_fields :total, :amout, :calculated_tax
+      #
+      def has_money_fields(*fieldnames)
+        self.money_fields = fieldnames
+        include InstanceMethods
+      end
+
+      # Check if a given field is declared as money field
+      # ==== Parameter
+      # fieldname<String>:: The fieldname to check. Is be casted into a symbol.
+      def is_money_field?(fieldname)
+        self.money_fields.include?(fieldname.to_sym)
+      end
+
+    end #ClassMethods
+
+    module InstanceMethods
+      # Check if a given field is declared as money field
+      # ==== Parameter
+      # fieldname<String>:: The fieldname to check. Is casted into a symbol.
+      def is_money_field?(fieldname)
+        self.class.money_fields.include?(fieldname.to_sym)
+      end
+    end
+    
+  end #Fields
+end#KingFormat

data/king_format/lib/model_mixins/has_percent_fields.rb

@@ -0,0 +1,34 @@
+module KingFormat
+  #TODO:
+  # split money / percent
+  # kick numeric? only used in list helper
+  module PercentFields
+
+    def self.included(base)
+      base.send :class_inheritable_accessor, :percent_fields
+      base.percent_fields = []
+      base.extend(ClassMethods)
+    end
+
+
+    module ClassMethods
+      #  Defines the fields returned by self.percent_fields.
+      # ===== Parameter
+      # fieldnames<Array[Symbol]>:: fieldnames/instance method names as symbols
+      # ==== Example
+      # class Invoice
+      #   has_percent_fields :total, :amout, :calculated_tax
+      #
+      def has_percent_fields(*fieldnames)
+        self.percent_fields = fieldnames
+        #include InstanceMethods
+      end
+
+      # Check if a given field is declared as percent
+      def is_percent_field?(fieldname)
+        self.percent_fields.include?(fieldname) if self.respond_to?(:percent_fields)
+      end
+    end
+
+  end #Fields
+end#KingFormat

data/king_format/tasks/king_format_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :king_format do
+#   # Task goes here
+# end

data/king_format/test/king_format_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class KingFormatTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/king_format/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'