gov_uk_date_fields 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 34866dac045629eb836f99aa75a2517669e7e5d6
+  data.tar.gz: 1fbb68fa5675ea1defa9b7b22a2e94c8b1ae64d0
+SHA512:
+  metadata.gz: 7edae5e8273014df61c7a37b5f80866815e9dfaa812c1c0acbd2b2a68f486af5364d56cb906d158ad0ae06831f90ce63508b99e8c29eaadfa89be74725bbdb77
+  data.tar.gz: 61f6b85a1eeae54ddc8fb24a5692c026326515f925b0724664bd0d2d4ea943e38dbe4e31a4c970eaafffa0af2ae947ed4668089127e7d42da79b965adf3323c7

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Stephen Richards
+
+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/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'GovUkDateFields'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/gov_uk_date_fields/acts_as_gov_uk_date.rb

@@ -0,0 +1,122 @@
+module GovUkDateFields
+  module ActsAsGovUkDate
+    extend ActiveSupport::Concern
+
+    included do
+    end
+
+    module ClassMethods
+      def acts_as_gov_uk_date(*date_fields)
+
+        validate :validate_gov_uk_dates
+
+        after_initialize :populate_gov_uk_dates
+
+        cattr_accessor :_gov_uk_dates
+        self._gov_uk_dates = date_fields
+
+
+        # call valid? on each of the gov_uk date fields, and add error messages
+        # into the errors hash if not valid
+        #
+        define_method(:validate_gov_uk_dates) do
+          date_fields.each do |date_field|
+            unless self.instance_variable_get("@_#{date_field}".to_sym).valid?
+              errors[date_field] << "Invalid date"
+            end
+          end
+        end
+
+
+        # This is an after initialize method.  We want to populate every gov_uk_date_field, unless it's a new
+        # record, and there is already a non-nil form date (this happens when you call new and pass a hash of attributes and values)
+        define_method(:populate_gov_uk_dates) do
+          self._gov_uk_dates.each do |date_field|
+            next if self.new_record? && self.instance_variable_get("@_#{date_field}".to_sym) != nil
+            GovUkDateFields::FormDate.set_from_date(self, date_field, self[date_field])
+          end
+        end
+
+
+
+        # For each of the gov uk date fields, we have to define the following 
+        # instance methods (assuming the date field name is dob):
+        #
+        # * dob       - retuns the date object (i.e. @_dob.date)
+        # * dob=      - populatees @_dob
+        # * dob_dd    - returns the day value for form popualtion
+        # * dob_dd=   - sets the day value (used when updating from a form)
+        # * dob_mm    - returns the month value for form popualtion
+        # * dob_mm=   - sets the month value (used when updating from a form)
+        # * dob_yyyy  - returns the year value for form popualtion
+        # * dob_yyyy= - sets the year value (used when updating from a form)
+        #
+        date_fields.each do |field|
+
+          # #dob -return @_dob.date
+          define_method(field) do
+            return self.instance_variable_get("@_#{field}".to_sym).date
+          end
+
+          # #dob=(date) = assigns a date to the GovukDateFields::FormDate object
+          define_method("#{field}=") do |new_date|
+            raise ArgumentError.new("#{new_date} is not a Date object") unless new_date.is_a?(Date) || new_date.nil?
+            GovUkDateFields::FormDate.set_from_date(self, field, new_date)
+          end
+
+          # #dob_dd   - return the day value for form population
+          define_method("#{field}_dd") do
+            return self.instance_variable_get("@_#{field}".to_sym).dd
+          end       
+
+          # #dob_mm   - return the day value for form population
+          define_method("#{field}_mm") do
+            return self.instance_variable_get("@_#{field}".to_sym).mm
+          end    
+
+          # #dob_yyyy   - return the day value for form population
+          define_method("#{field}_yyyy") do
+            return self.instance_variable_get("@_#{field}".to_sym).yyyy
+          end  
+
+          # #dob_dd= - set the day part of the date (used in population of model from form)
+          define_method("#{field}_dd=") do |day| 
+            GovUkDateFields::FormDate.set_date_part(:dd, self, field, day)
+          end   
+
+          # #dob_dd= - set the day part of the date (used in population of model from form)
+          define_method("#{field}_mm=") do |month| 
+            GovUkDateFields::FormDate.set_date_part(:mm, self, field, month)
+          end   
+
+          # #dob_dd= - set the day part of the date (used in population of model from form)
+          define_method("#{field}_yyyy=") do |year| 
+            GovUkDateFields::FormDate.set_date_part(:yyyy, self, field, year)
+          end   
+
+        end
+
+        after_initialize :populate_gov_uk_dates
+
+        include GovUkDateFields::ActsAsGovUkDate::LocalInstanceMethods
+      end
+    end
+
+    module LocalInstanceMethods
+      def populate_gov_uk_dates
+        self._gov_uk_dates.each do |field_name|
+          GovUkDateFields::FormDate.set_from_date(self, field_name, self[field_name])
+        end
+      end
+
+      # def populate_gov_uk_dates_from_form_fields
+      #   MojDateFields::FormDate.set_from_date(self, :first_day_of_trial, self['first_day_of_trial'])
+      # end
+    end
+
+
+  end
+end
+
+ActiveRecord::Base.send :include, GovUkDateFields::ActsAsGovUkDate
+

data/lib/gov_uk_date_fields/form_builder.rb

@@ -0,0 +1,12 @@
+
+
+ActionView::Helpers::FormBuilder.class_eval do
+
+  def gov_uk_date_field(attribute)
+    date_fields = GovUkDateFields::FormFields.new(self, @object_name, attribute)
+    date_fields.output
+  end
+
+end
+
+ 

data/lib/gov_uk_date_fields/form_date.rb

@@ -0,0 +1,127 @@
+module GovUkDateFields
+
+  class FormDateError < RuntimeError; end
+
+
+  class FormDate
+
+    attr_accessor :dd, :mm, :yyyy, :date, :temp
+    
+    # This method cannot be called directly: use .new_from_date or .new_from_params
+    def initialize(dd, mm, yyyy, date = nil)
+     @dd            = dd
+     @mm            = mm
+     @yyyy          = yyyy
+     @date          = date
+     @valid         = date.nil? ? validate_date : true
+    end
+  
+    # Creates a FormDate object from the date, and writes it to @_<attr_name>
+    # on the object, and updates the attr[<attr_name>] with the real date object
+    #
+    def self.set_from_date(object, attr_name, date)
+      if date.nil?
+        form_date = new('', '', '')
+      else
+        form_date = new(date.day.to_s, date.month.to_s, date.year.to_s, date)
+      end
+      update_object(object, attr_name, form_date)
+    end
+
+
+    
+    def self.set_date_part(date_part, object, attr_name, value)
+      form_date = object.instance_variable_get("@_#{attr_name}".to_sym) || FormDate.nil_date
+      form_date.send("#{date_part}=", value)
+      form_date.create_date_from_date_parts
+      FormDate.update_object(object, attr_name, form_date)
+    end
+
+
+    def self.nil_date
+      new('', '', '')
+    end
+
+
+    def create_date_from_date_parts
+      @valid = true
+      if @dd.blank? && @mm.blank? && @yyyy.blank?
+        @date = nil
+      else
+        months = %w{ jan feb mar apr may jun jul aug sep oct nov dec }
+        mm_as_int = months.include?(@mm.downcase) ? months.index(@mm.downcase) + 1 : @mm.to_i
+        begin
+          @date = Date.new(@yyyy.to_i, mm_as_int, @dd.to_i)
+        rescue ArgumentError => err
+          raise err unless err.message == 'invalid date'
+          @valid = false
+        end
+      end
+    end
+
+
+    # Creates a FormDate object from the params, and writes it to the instance variable @_<attr_name> 
+    # on the object, and updates the attr[attr_name] with the real date object
+    #
+    # If the dob_dd, dob_mm, dob_yy are not in the params hash, or if they are all blank, the object is 
+    # not updated.
+    #
+    # def self.set_from_params(object, attr_name, params)
+    #   params = HashWithIndifferentAccess.new(params) unless params.is_a?(HashWithIndifferentAccess)
+    #   return if attr_not_present_in_params?(attr_name, params)
+    #   form_date = new(params["#{attr_name}_dd"], params["#{attr_name}_mm"], params["#{attr_name}_yyyy"] )
+    #   update_object(object, attr_name, form_date)
+    # end
+
+    def valid?
+      @valid
+    end
+
+    private_class_method :new
+
+    private 
+
+
+    def transfer_temp_fields_to_live
+      @dd = @temp[:dd]
+      @mm = @temp[:mm]
+      @yyyy = @temp[:yyyy]
+    end
+
+    
+
+    def self.update_object(object, attr_name, form_date)
+      object.instance_variable_set("@_#{attr_name}".to_sym, form_date)
+      object[attr_name] = form_date.date
+    end
+
+
+    def self.attr_not_present_in_params?(attr_name, params)
+      attr_missing_in_params?(attr_name, params)  || all_blanks_in_params?(attr_name, params)
+    end
+
+    def self.attr_missing_in_params?(attr_name, params) 
+      params["#{attr_name}_dd"].nil? &&  params["#{attr_name}_mm"].nil? &&  params["#{attr_name}_yyyy"].nil?
+    end
+
+    def self.all_blanks_in_params?(attr_name, params)
+      params["#{attr_name}_dd"].blank? &&  params["#{attr_name}_mm"].blank? &&  params["#{attr_name}_yyyy"].blank?
+    end
+
+
+    def validate_date
+      return true if @dd.blank? && @mm.blank? && @yyyy.blank?
+      months = %w{ jan feb mar apr may jun jul aug sep oct nov dec }
+
+      mm_as_int = months.include?(@mm.downcase) ? months.index(@mm.downcase) + 1 : @mm.to_i
+      begin
+        @date = Date.new(@yyyy.to_i, mm_as_int, @dd.to_i)
+      rescue ArgumentError => err
+        return false if err.message == 'invalid date'
+        raise err
+      end
+    end
+
+  end
+
+end

data/lib/gov_uk_date_fields/form_fields.rb

@@ -0,0 +1,49 @@
+module GovUkDateFields
+
+  class FormFields
+    DATE_SEGMENTS = {
+      day:    '_dd',
+      month:  '_mm',
+      year:   '_yyyy'
+    }
+
+    def initialize(form, object_name, attribute)
+      @form        = form
+      @object      = form.object
+      @object_name = object_name
+      @attribute   = attribute
+    end
+
+    def output
+      day_value = @object.send("#{@attribute}_dd")
+      month_value = @object.send("#{@attribute}_mm")
+      year_value = @object.send("#{@attribute}_yyyy")
+
+      %Q[
+        #{@form.text_field(@attribute, field_options(day_value, html_id(:day), html_name(:day), 'DD', 2))}
+        #{@form.text_field(@attribute, field_options(month_value, html_id(:month), html_name(:month), 'MM', 3))}
+        #{@form.text_field(@attribute, field_options(year_value, html_id(:year), html_name(:year), 'YYYY', 4))}
+      ].html_safe
+    end
+
+    private
+
+    def html_id(date_segment)
+      html_name(date_segment).gsub(/\]\[|\[|\]|\(/, '_').gsub(/\_\z/, '').gsub(/\)/, '')
+    end
+
+    def html_name(date_segment)
+      "#{@object_name}[#{@attribute}#{DATE_SEGMENTS[date_segment]}]"
+    end
+
+    def field_options(value, id, name, placeholder, size)
+      {
+        value: value,
+        id: id,
+        name: name,
+        placeholder: placeholder,
+        size: size
+      }
+    end
+  end
+end

data/lib/gov_uk_date_fields/gov_uk_date_fields.rb

@@ -0,0 +1,2 @@
+module GovUkDateFields
+end

data/lib/gov_uk_date_fields/version.rb

@@ -0,0 +1,3 @@
+module GovUkDateFields
+  VERSION = "0.0.1"
+end

data/lib/gov_uk_date_fields.rb

@@ -0,0 +1,7 @@
+require 'gov_uk_date_fields/acts_as_gov_uk_date'
+require 'gov_uk_date_fields/form_date'
+require 'gov_uk_date_fields/form_fields'
+require 'gov_uk_date_fields/form_builder'
+
+module GovUkDateFields
+end

data/lib/tasks/gov_uk_date_fields_tasks.rake

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

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .