custom_fielder 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 648a2e684dae174f93a7d853c5b407938e1c8794
+  data.tar.gz: 595befc53d7a9bd52f472316d65e6f2c360c6a3c
+SHA512:
+  metadata.gz: 4dc3de13896746fcede6569e862bc147e7952fc8238cc277e1cddae8ff763701f8a483750299cec6a8f2098c5bb2c5ae0d308d4a46f0a9fa0135379ff9e44979
+  data.tar.gz: cf8ec45b8d4068cabf2ce3620a513015f4acbc3d2cffed34d2033406534ddda6733dae4750ea24dfa234cf4046a42d2b1f4d31ebf1f13ffdc9249f94ada96682

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Nick Hurst
+
+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,26 @@
+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    = 'CustomFielder'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/javascripts/custom_fielder/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 .

data/app/assets/stylesheets/custom_fielder/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/custom_fielder/application_controller.rb

@@ -0,0 +1,5 @@
+module CustomFielder
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/helpers/custom_fielder/application_helper.rb

@@ -0,0 +1,4 @@
+module CustomFielder
+  module ApplicationHelper
+  end
+end

data/app/helpers/custom_fielder/deserialization_helper.rb

@@ -0,0 +1,83 @@
+module CustomFielder
+  module DeserializationHelper
+
+    FALSE_VALUES = [false, 0, '0', 'f', 'F', 'false', 'FALSE', 'off', 'OFF']
+
+    ##
+    # @return [Array|Integer|Float|Date|DateTime|Boolean|String]
+    #
+    def deserialize(type, value)
+      send("#{type.underscore}", value)
+    end
+
+    ##
+    # @return [Array]
+    #
+    def array(value)
+      value.delete('[]"').split(', ').map do |val|
+        case val
+        when /^\d+$/
+          val.to_i
+        when /^\d+\.\d+$/
+          val.to_f
+        when /^\d{4}-\d{2}-\d{2}$/
+          date(val)
+        when /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}-\d{2}:\d{2}$/
+          date_time(val)
+        when 'true'
+          true
+        when 'false'
+          false
+        when /".+"/
+          val.delete('"')
+        else
+          val
+        end
+      end
+    end
+
+    ##
+    # @return [Integer]
+    #
+    def integer(value)
+      value.to_i
+    end
+
+    ##
+    # @return [Float]
+    #
+    def float(value)
+      value.to_f
+    end
+
+    ##
+    # @return [Date]
+    #
+    def date(value)
+      Date.parse(value)
+    end
+
+    ##
+    # @return [DateTime]
+    #
+    def date_time(value)
+      DateTime.parse(value)
+    end
+
+    ##
+    # @return [Boolean]
+    #
+    def boolean(value)
+      return false if FALSE_VALUES.include?(value)
+      true
+    end
+
+    ##
+    # @return [String]
+    #
+    def string(value)
+      value
+    end
+
+  end
+end

data/app/helpers/custom_fielder/type_checking_helper.rb

@@ -0,0 +1,88 @@
+module CustomFielder
+  module TypeCheckingHelper
+
+    TRUTH_VALUES = [true,  1, '1', 't', 'T', 'true',  'TRUE',  'on',  'ON']
+    FALSE_VALUES = [false, 0, '0', 'f', 'F', 'false', 'FALSE', 'off', 'OFF']
+
+    ##
+    # @return [Boolean]
+    #
+    def is_correct_type?(type, value)
+      send("is_#{type.underscore}?", value)
+    end
+
+    ##
+    # @return [Boolean]
+    #
+    def is_array?(value)
+      unless value =~ /^\[(.(, )?)+\]$/
+        false
+      else
+        true
+      end
+    end
+
+    ##
+    # @return [Boolean]
+    #
+    def is_integer?(value)
+      unless value =~ /^\d+$/
+        false
+      else
+        true
+      end
+    end
+
+    ##
+    # @return [Boolean]
+    #
+    def is_float?(value)
+      unless value =~ /^\d+\.\d+$/
+        false
+      else
+        true
+      end
+    end
+
+    ##
+    # @return [Boolean]
+    #
+    def is_date?(value)
+      unless value =~ /^\d{4}-\d{2}-\d{2}$/
+        false
+      else
+        true
+      end
+    end
+
+    ##
+    # @return [Boolean]
+    #
+    def is_date_time?(value)
+      unless value =~ /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}-\d{2}:\d{2}$/
+        false
+      else
+        true
+      end
+    end
+
+    ##
+    # @return [Boolean]
+    #
+    def is_boolean?(value)
+      unless TRUTH_VALUES.include?(value) or FALSE_VALUES.include?(value)
+        false
+      else
+        true
+      end
+    end
+
+    ##
+    # @return [Boolean]
+    #
+    def is_string?(value)
+      true
+    end
+
+  end
+end

data/app/models/custom_fielder/custom_field.rb

@@ -0,0 +1,180 @@
+module CustomFielder
+  class CustomField < ActiveRecord::Base
+    include TypeCheckingHelper
+    include DeserializationHelper
+
+    before_validation :set_default
+
+    validate :check_type
+    validate :check_allow_blank
+    validate :check_allowed_values
+
+    belongs_to :field_attributes, dependent: :destroy, class_name: 'FieldAttributes'
+    belongs_to :custom_fieldable, polymorphic: true
+
+    ##
+    # Because everything is stored as string with ActiveRecord
+    # we use a alias method chain to rename the value method that
+    # uses the ActiveRecord String value to raw_value so when
+    # value is called it returns the deserialized value
+    #
+    def value; super; end
+    alias_method :raw_value, :value
+    def value; deserialize_value; end;
+
+    ##
+    # Adds class methods to deactivate or activate all the fields
+    # that belong to the passed attribute object
+    #
+    class << self
+      {
+        deactivate_field_for_all: false,
+        activate_field_for_all: true
+      }.each do |change_field_active_value, field_active_value|
+        define_method change_field_active_value do |field_attrs|
+          fields = all.where(field_attributes_id: field_attrs.id)
+          fields.each do |field|
+            field.active = field_active_value
+            field.save
+          end
+        end
+      end
+    end
+
+    private
+
+    ##
+    # Gets the field type from the field attributes
+    #
+    # @return [String]
+    #
+    def type
+      @type ||= field_attributes.field_type
+    end
+
+    ##
+    # Gets the boolean value of allow blank from field attributes
+    #
+    # @return [Boolean]
+    #
+    def allow_blank
+      @allow_blank ||= field_attributes.allow_blank
+    end
+
+    ##
+    # Gets the array of allowed values from field attributes
+    #
+    # @return [Array]
+    #
+    def allowed_values
+      @allowed_values ||= begin
+        unless field_attributes.allowed_values.nil?
+          deserialize('Array', field_attributes.allowed_values)
+        else
+          nil
+        end
+      end
+    end
+
+    ##
+    # Gets the default value from the field attributes
+    #
+    # @return [String]
+    #
+    def default
+      @default ||= field_attributes.default
+    end
+
+    ##
+    # Deserializes the field value that is stored as a string
+    #
+    # @return [Array|Integer|Float|Date|DateTime|Boolean|String]
+    #
+    def deserialize_value
+      @deserialized_value ||= deserialize(type, raw_value)
+    end
+
+    ##
+    # Sets the value to the default if value is blank
+    #
+    # @return [Nil]
+    #
+    def set_default
+      if (default and default != '') and (!raw_value or raw_value == '')
+        update_attribute(:value, default)
+      end
+    end
+
+    ##
+    # @return [Boolean|Nil] Adds error if invalid
+    #
+    def check_type
+      if raw_value == nil or raw_value == ''
+        return true
+      end
+
+      unless is_correct_type?(type, raw_value)
+        value_mismatch_error
+      else
+        true
+      end
+    end
+
+    ##
+    # @return [Boolean|Nil] Adds error if invalid
+    #
+    def check_allow_blank
+      if allow_blank == false and (raw_value == nil or raw_value == '')
+        value_blank_error
+      else
+        true
+      end
+    end
+
+    ##
+    # @return [Boolean|Nil] Adds error if invalid
+    #
+    def check_allowed_values
+      if allowed_values == nil
+        return true
+      end
+
+      unless allowed_values.include?(value)
+        value_not_allowed_error
+      else
+        true
+      end
+    end
+
+    ##
+    # If a value is passed that does not match field type adds
+    # a mismatch error
+    #
+    # @return [nil]
+    #
+    def value_mismatch_error
+      errors.add(:value, 'value passed does not match field type')
+    end
+
+    ##
+    # If a value is passed that is blank and allow_blank is false
+    # adds a value blank error
+    #
+    # @return [nil]
+    #
+    def value_blank_error
+      errors.add(:value, 'blank value passed when allow blank is false')
+    end
+
+    ##
+    # If a value is passed that is not included in allowed values
+    # adds a value not allowed error
+    #
+    # @return [nil]
+    #
+    def value_not_allowed_error
+      errors.add(:value, 'value passed not in allowed values')
+    end
+
+  end
+end

data/app/models/custom_fielder/field_attributes.rb

@@ -0,0 +1,10 @@
+module CustomFielder
+  class FieldAttributes < ActiveRecord::Base
+    has_many :custom_fields
+
+    validates :name,          presence: true
+    validates :field_type,    presence: true,
+                              inclusion: { in: %w[Array Integer Float Date DateTime Boolean String] }
+    validates :allow_blank,   inclusion: { in: [true, false] }
+  end
+end

data/app/views/layouts/custom_fielder/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>CustomFielder</title>
+  <%= stylesheet_link_tag    "custom_fielder/application", media: "all" %>
+  <%= javascript_include_tag "custom_fielder/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+CustomFielder::Engine.routes.draw do
+end

data/db/migrate/20160525133243_create_custom_fielder_custom_fields.rb

@@ -0,0 +1,12 @@
+class CreateCustomFielderCustomFields < ActiveRecord::Migration
+  def change
+    create_table :custom_fielder_custom_fields do |t|
+      t.references :custom_fieldable,     polymorphic: true, index: { name: 'index_custom_fields_on_fieldable_type_and_fieldable_id' }, null: false
+      t.integer    :field_attributes_id,  null: false
+      t.boolean    :active,               null: false, default: true
+      t.string     :value
+
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20160525133922_create_custom_fielder_field_attributes.rb

@@ -0,0 +1,13 @@
+class CreateCustomFielderFieldAttributes < ActiveRecord::Migration
+  def change
+    create_table :custom_fielder_field_attributes do |t|
+      t.string  :name,            null: false
+      t.string  :field_type,      null: false
+      t.string  :default
+      t.boolean :allow_blank,     null: false
+      t.text    :allowed_values,  array: true
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/custom_fielder/custom_fieldable.rb

@@ -0,0 +1,35 @@
+module CustomFielder
+  module CustomFieldable
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :custom_fielder_custom_fields,
+        as: :custom_fieldable,
+        dependent: :destroy,
+        class_name: 'CustomFielder::CustomField'
+
+      has_many :custom_fielder_field_attributes,
+        through: :custom_fielder_custom_fields,
+        class_name: 'CustomFielder::FieldAttributes',
+        source: :field_attributes
+
+      alias_method :custom_fields,            :custom_fielder_custom_fields
+      alias_method :custom_field_attributes,  :custom_fielder_field_attributes
+
+      ##
+      # Returns a hash where the keys are the field names
+      # and the values are the field values
+      #
+      # @return [Hash]
+      #
+      def get_custom_fields_with_values
+        custom_fields.inject(Hash.new) do |h, cf|
+          field_name = cf.field_attributes.name
+          h[field_name] = cf.value
+          h
+        end
+      end
+    end
+
+  end
+end

data/lib/custom_fielder/engine.rb

@@ -0,0 +1,9 @@
+module CustomFielder
+  class Engine < ::Rails::Engine
+    isolate_namespace CustomFielder
+
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+  end
+end

data/lib/custom_fielder/version.rb

@@ -0,0 +1,3 @@
+module CustomFielder
+  VERSION = "0.5.0"
+end

data/lib/custom_fielder.rb

@@ -0,0 +1,5 @@
+require "custom_fielder/engine"
+
+module CustomFielder
+  autoload :CustomFieldable, 'custom_fielder/custom_fieldable'
+end

data/lib/tasks/custom_fielder_tasks.rake

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

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: custom_fielder
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Nick Hurst
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- hurst.178@osu.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- app/assets/javascripts/custom_fielder/application.js
+- app/assets/stylesheets/custom_fielder/application.css
+- app/controllers/custom_fielder/application_controller.rb
+- app/helpers/custom_fielder/application_helper.rb
+- app/helpers/custom_fielder/deserialization_helper.rb
+- app/helpers/custom_fielder/type_checking_helper.rb
+- app/models/custom_fielder/custom_field.rb
+- app/models/custom_fielder/field_attributes.rb
+- app/views/layouts/custom_fielder/application.html.erb
+- config/routes.rb
+- db/migrate/20160525133243_create_custom_fielder_custom_fields.rb
+- db/migrate/20160525133922_create_custom_fielder_field_attributes.rb
+- lib/custom_fielder.rb
+- lib/custom_fielder/custom_fieldable.rb
+- lib/custom_fielder/engine.rb
+- lib/custom_fielder/version.rb
+- lib/tasks/custom_fielder_tasks.rake
+homepage: http://www.github.com/no_homepage_yet
+licenses:
+- MIT
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Adds the ability to allow user defined custom fields on models.
+test_files: []
+has_rdoc: