form_core_v1 0.0.14

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 87a636a0d0d56a208122563acd0ef6d26a6a00fe
+  data.tar.gz: 70c4bd33de24eb514df38432678be77e21a9f567
+SHA512:
+  metadata.gz: 36cb5e15b9fa07d70ff05c5731f9d0c9dc902581d436e0252dd7e78468876df4471d369e82a2554527cf189e32028b6d6b166eb9f8461a53ebea93fe88e77a2c
+  data.tar.gz: 93bc33f7b006822a1d09da402af63b4b5d778a4d6cb1102e569ecaa6d45260bc51a3049a2dbd7254de6d5b49e60845954c1568dd8588d592186aef2a53e5a032

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Jun Jiang
+
+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/README.md

@@ -0,0 +1,97 @@
+Form Core
+====
+
+A Rails engine providing ability to generate dynamic form.
+
+## Requirements
+
+- MRI 2.3+
+- Rails 5.0+
+
+## Usage
+
+See demo for now.
+
+## Installation
+
+Add this line to your Gemfile:
+
+```ruby
+gem 'form_core'
+```
+
+Or you may want to include the gem directly from GitHub:
+
+```ruby
+gem 'form_core', github: 'jasl-lab/form_core'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Copy migrations
+
+```sh
+$ bin/rails form_core:install:migrations
+```
+
+Then do migrate
+
+```sh
+$ bin/rails db:migrate
+```
+
+## Demo
+
+Clone the repository.
+
+```sh
+$ git clone https://github.com/jasl-lab/form_core.git
+```
+
+Change directory
+
+```sh
+$ cd form_core
+```
+
+Run bundler
+
+```sh
+$ bundle install
+```
+
+Preparing database
+
+```sh
+$ bin/rails db:migrate
+```
+
+Start the Rails server
+
+```sh
+$ bin/rails s
+```
+
+Open your browser, and visit `http://localhost:3000`
+
+## Contributing
+
+Bug report or pull request are welcome.
+
+### Make a pull request
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+Please write unit test with your code if necessary.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+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    = "FormCore"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test

data/lib/form_core.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "form_core/engine"
+require "form_core/errors"
+
+require "form_core/coder"
+require "form_core/coders/hash_coder"
+require "form_core/coders/yaml_coder"
+
+require "form_core/virtual_model"
+require "form_core/concerns/models/form"
+require "form_core/concerns/models/field"
+
+module FormCore
+  class << self
+    def virtual_model_class
+      @virtual_model_class ||= VirtualModel
+    end
+
+    def virtual_model_class=(klass)
+      unless klass && klass < VirtualModel
+        raise ArgumentError, "#{klass} should be sub-class of #{VirtualModel}."
+      end
+
+      @reserved_names = nil
+      @virtual_model_class = klass
+    end
+
+    def reserved_names
+      @reserved_names ||= Set.new(
+        %i(def class module private public protected allocate new parent superclass) +
+          virtual_model_class.instance_methods(true)
+      )
+    end
+
+    def virtual_model_coder_class
+      @virtual_model_coder_class ||= HashCoder
+    end
+
+    def virtual_model_coder_class=(klass)
+      unless klass && klass < Coder
+        raise ArgumentError, "#{klass} should be sub-class of #{Coder}."
+      end
+
+      @virtual_model_coder_class = klass
+    end
+  end
+end

data/lib/form_core/coder.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module FormCore
+  class Coder
+    cattr_accessor :strict
+
+    attr_reader :object_class
+
+    def initialize(object_class)
+      @object_class = object_class
+    end
+
+    def strict?
+      Coder.strict
+    end
+
+    def dump(_obj)
+      raise NotImplementedError
+    end
+
+    def load(_src)
+      raise NotImplementedError
+    end
+
+    private
+
+    def new_or_raise_decoding_error
+      if strict?
+        raise DecodingDataCorrupted
+      else
+        object_class.new
+      end
+    end
+
+    def valid_attribute_names
+      object_class.attribute_names + object_class._embeds_reflections.keys
+    end
+
+    def valid_attributes(hash)
+      hash.slice(*valid_attribute_names)
+    end
+  end
+end

data/lib/form_core/coders/hash_coder.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+module FormCore
+  class HashCoder < FormCore::Coder # :nodoc:
+    def dump(obj)
+      obj&.serializable_hash || {}
+    end
+
+    def load(hash)
+      if hash.nil? || !hash.respond_to?(:to_h)
+        return new_or_raise_decoding_error
+      end
+
+      object_class.new valid_attributes(hash)
+    end
+  end
+end

data/lib/form_core/coders/yaml_coder.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+module FormCore
+  class YAMLCoder < FormCore::Coder # :nodoc:
+    cattr_accessor :safe_mode
+
+    def self.whitelist_classes
+      @whitelist_classes ||= []
+    end
+
+    def safe_mode?
+      YAMLCoder.safe_mode
+    end
+
+    def dump(obj)
+      return YAML.dump({}) unless obj
+
+      YAML.dump obj.serializable_hash
+    end
+
+    def load(yaml)
+      return object_class.new if yaml.blank?
+
+      unless yaml.is_a?(String) && /^---/.match?(yaml)
+        return new_or_raise_decoding_error
+      end
+
+      decoded =
+        if safe_mode?
+          YAML.safe_load(yaml, YAMLCoder.whitelist_classes)
+        else
+          YAML.load(yaml)
+        end
+      unless decoded.is_a? Hash
+        return new_or_raise_decoding_error
+      end
+
+      object_class.new valid_attributes(decoded)
+    end
+  end
+end

data/lib/form_core/concerns/models/field.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module FormCore::Concerns
+  module Models
+    module Field
+      extend ActiveSupport::Concern
+
+      NAME_REGEX = /\A[a-z_][a-z_0-9]*\z/
+
+      included do
+
+        serialize :validations
+        serialize :options
+
+        validates :name,
+                  presence: true,
+                  uniqueness: {scope: :form},
+                  exclusion: {in: FormCore.reserved_names},
+                  format: {with: NAME_REGEX}
+
+        after_initialize do
+          self.validations ||= {}
+          self.options ||= {}
+        end
+      end
+
+      def name
+        self[:name]&.to_sym
+      end
+
+      def stored_type
+        raise NotImplementedError
+      end
+
+      def default_value
+        nil
+      end
+
+      def interpret_to(model, overrides: {})
+        check_model_validity!(model)
+
+        default_value = overrides.fetch(:default_value, self.default_value)
+        model.attribute name, stored_type, default: default_value
+
+        interpret_validations_to model, overrides
+        interpret_extra_to model, overrides
+
+        model
+      end
+
+      protected
+
+      def interpret_validations_to(model, overrides = {})
+        validations = overrides.fetch(:validations, (self.validations || {}))
+        validation_options = overrides.fetch(:validation_options) { self.options.fetch(:validation, {}) }
+
+        if validations.present?
+          model.validates name, **validations, **validation_options
+        end
+      end
+
+      def interpret_extra_to(_model, _overrides = {})
+      end
+
+      def check_model_validity!(model)
+        unless model.is_a?(Class) && model < ::FormCore::VirtualModel
+          raise ArgumentError, "#{model} must be a #{::FormCore::VirtualModel}'s subclass"
+        end
+      end
+    end
+  end
+end

data/lib/form_core/concerns/models/form.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module FormCore::Concerns
+  module Models
+    module Form
+      extend ActiveSupport::Concern
+
+      def to_virtual_model(model_name: "Form",
+                           fields_scope: proc { |fields| fields },
+                           overrides: {})
+        model = FormCore.virtual_model_class.build model_name
+
+        append_to_virtual_model(model, fields_scope: fields_scope, overrides: overrides)
+      end
+
+      def append_to_virtual_model(model,
+                                  fields_scope: proc { |fields| fields },
+                                  overrides: {})
+        check_model_validity! model
+
+        global_overrides = overrides.fetch(:_global, {})
+        fields_scope.call(fields).each do |f|
+          f.interpret_to model, overrides: global_overrides.merge(overrides.fetch(f.name, {}))
+        end
+
+        model
+      end
+
+      private
+
+      def check_model_validity!(model)
+        unless model.is_a?(Class) && model < ::FormCore::VirtualModel
+          raise ArgumentError, "#{model} must be a #{::FormCore::VirtualModel}'s subclass"
+        end
+      end
+    end
+  end
+end

data/lib/form_core/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module FormCore
+  class Engine < ::Rails::Engine
+    isolate_namespace FormCore
+  end
+end

data/lib/form_core/errors.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module FormCore
+  # = Form Core Errors
+  #
+  # Generic Form Core exception class.
+  class FormCoreError < StandardError
+  end
+
+  class DecodingDataCorrupted < FormCoreError
+  end
+end

data/lib/form_core/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FormCore
+  VERSION = "0.0.14"
+end

data/lib/form_core/virtual_model.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "duck_record"
+
+module FormCore
+  class VirtualModel < ::DuckRecord::Base
+    # Returns the contents of the record as a nicely formatted string.
+    def inspect
+      # We check defined?(@attributes) not to issue warnings if the object is
+      # allocated but not initialized.
+      inspection =
+        if defined?(@attributes) && @attributes
+          self.class.attribute_names.collect do |name|
+            if has_attribute?(name)
+              "#{name}: #{attribute_for_inspect(name)}"
+            end
+          end.compact.join(", ")
+        else
+          "not initialized"
+        end
+
+      "#<VirtualModel:#{self.class.name}:#{object_id} #{inspection}>"
+    end
+
+    def serializable_hash(options = {})
+      options = (options || {}).reverse_merge include: self.class._embeds_reflections.keys
+      super options
+    end
+
+    def dump
+      self.class.dump(self)
+    end
+
+    class << self
+      def name
+        @_name ||= "Form"
+      end
+
+      def name=(value)
+        value = value.classify
+        raise ArgumentError, "`value` isn't a valid class name" if value.blank?
+
+        @_name = value
+      end
+
+      def coder
+        @_coder ||= FormCore.virtual_model_coder_class.new(self)
+      end
+
+      def coder=(klass)
+        unless klass && klass < Coder
+          raise ArgumentError, "#{klass} should be sub-class of #{Coder}."
+        end
+
+        @_coder = klass.new(self)
+      end
+
+      delegate :dump, :load, to: :coder, allow_nil: false
+
+      def build(name = nil)
+        klass = Class.new(self)
+        klass.name = name
+        klass
+      end
+
+      # Returns a string like "Post(id:integer, title:string, body:text)"
+      def inspect
+        attr_list = attribute_types.map { |name, type| "#{name}: #{type.type}" } * ", "
+        "#<VirtualModel:#{name}:#{object_id} #{attr_list}>"
+      end
+
+      def _embeds_reflections
+        _reflections.select { |_, v| v.is_a? DuckRecord::Reflection::EmbedsAssociationReflection }
+      end
+    end
+  end
+end

data/lib/tasks/form_core_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :form_core do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: form_core_v1
+version: !ruby/object:Gem::Version
+  version: 0.0.14
+platform: ruby
+authors:
+- jasl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: duck_record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  A Rails engine providing ability to generate dynamic form.
+    It's would make such as dynamic fields of model or questionnaire easily.
+email:
+- jasl9187@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/form_core.rb
+- lib/form_core/coder.rb
+- lib/form_core/coders/hash_coder.rb
+- lib/form_core/coders/yaml_coder.rb
+- lib/form_core/concerns/models/field.rb
+- lib/form_core/concerns/models/form.rb
+- lib/form_core/engine.rb
+- lib/form_core/errors.rb
+- lib/form_core/version.rb
+- lib/form_core/virtual_model.rb
+- lib/tasks/form_core_tasks.rake
+homepage: https://github.com/jasl-lab/form_core
+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.6.11
+signing_key: 
+specification_version: 4
+summary: A Rails engine providing ability to generate dynamic form.
+test_files: []