form_core 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5445ceba04d699e653eb979f4bbb4d47b2a02d35
+  data.tar.gz: 43378b5c8cc8ece05bf173e942a124edda795595
+SHA512:
+  metadata.gz: 054dd0d3d050c6700bea922a5fe6d672fae0b18e429869808da7576ea98b894e8be4f8dade8b625970ab68e319e9078e423068a76c120722e79427939f1158c7
+  data.tar.gz: de14cd9112daf2557a8548face1551591b8eaa8e4ab157b24306f35d1aaa59d16c6475761cadf9a0e4551320c5a14cf942ce981984395c3cf33d363abe8289d5

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,98 @@
+Form Core
+====
+
+A Rails engine provides ability to generate dynamic form.
+
+## Usage
+
+TODO
+
+## 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/form_core.git
+```
+
+Change directory
+
+```sh
+$ cd form_core
+```
+
+Run bundler
+
+```sh
+$ bundle install
+```
+
+Run yarn
+
+```sh
+$ test/dummy/bin/yarn
+```
+
+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,36 @@
+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/app/models/form_core/application_record.rb

@@ -0,0 +1,5 @@
+module FormCore
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/form_core/field.rb

@@ -0,0 +1,5 @@
+module FormCore
+  class Field < ApplicationRecord
+    include FormCore::Concerns::Models::Field
+  end
+end

data/app/models/form_core/form.rb

@@ -0,0 +1,5 @@
+module FormCore
+  class Form < ApplicationRecord
+    include FormCore::Concerns::Models::Form
+  end
+end

data/db/migrate/20170430190404_create_form_core_forms.rb

@@ -0,0 +1,9 @@
+class CreateFormCoreForms < ActiveRecord::Migration[5.1]
+  def change
+    create_table :form_core_forms do |t|
+      t.string :type, null: false, index: true
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20170430191336_create_form_core_fields.rb

@@ -0,0 +1,15 @@
+class CreateFormCoreFields < ActiveRecord::Migration[5.1]
+  def change
+    create_table :form_core_fields do |t|
+      t.string :name, null: false
+      t.integer :accessibility, null: false
+      t.text :validations
+      t.text :static_default_value
+      t.text :options
+      t.string :type, null: false
+      t.references :form, foreign_key: {to_table: :form_core_forms}
+
+      t.timestamps
+    end
+  end
+end

data/lib/form_core.rb

@@ -0,0 +1,46 @@
+require "form_core/engine"
+require "form_core/virtual_model"
+
+require "form_core/concerns/models/form"
+require "form_core/concerns/models/field"
+
+module FormCore
+  class << self
+    def field_classes
+      @field_classes ||= Set.new
+    end
+
+    def register_field_class(klass)
+      unless klass && klass < Field && !klass.abstract_class?
+        raise ArgumentError, "#{klass} should be sub-class of #{Field} and can't be abstract class."
+      end
+
+      field_classes << klass
+    end
+
+    def register_field_classes(*classes)
+      classes.each do |klass|
+        register_field_class klass
+      end
+    end
+
+    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
+
+      @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
+  end
+end

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

@@ -0,0 +1,87 @@
+module FormCore::Concerns
+  module Models
+    module Field
+      extend ActiveSupport::Concern
+
+      included do
+        belongs_to :form, touch: true
+
+        enum accessibility: {read_and_write: 0, read_only: 1, hidden: 2}
+
+        serialize :validations
+        serialize :options
+        serialize :static_default_value
+
+        validates :name,
+                  presence: true,
+                  uniqueness: {scope: :form},
+                  exclusion: {in: FormCore.reserved_names},
+                  format: {with: /\A[a-z0-9_]+\z/}
+        validates :accessibility,
+                  inclusion: {in: self.accessibilities.keys.map(&:to_sym)}
+
+        after_initialize do
+          self.validations ||= {}
+          self.options ||= {}
+          self.accessibility ||= "read_and_write"
+        end
+      end
+
+      def name
+        super&.to_sym
+      end
+
+      def accessibility
+        super&.to_sym
+      end
+
+      def stored_type
+        raise NotImplementedError
+      end
+
+      def default_value
+        ActiveModel::Type.lookup(stored_type).cast(static_default_value)
+      end
+
+      def interpret_to(model, overrides: {})
+        check_model_validity!(model)
+
+        accessibility = overrides.fetch(:accessibility, self.accessibility)
+        return model if accessibility == :hidden
+
+        default_value = overrides.fetch(:default_value, self.default_value)
+        model.attribute name, stored_type, default: default_value
+
+        if accessibility == :read_only
+          model.attr_readonly name
+        end
+
+        interpret_validations_to model, accessibility, overrides
+        interpret_extra_to model, accessibility, overrides
+
+        model
+      end
+
+      protected
+
+      def interpret_validations_to(model, accessibility, overrides = {})
+        validations = overrides.fetch(:validations, (self.validations || {}))
+        validation_options = overrides.fetch(:validation_options) { self.options.fetch(:validation, {}) }
+
+        if accessibility == :read_and_write && validations.present?
+          model.validates name, **validations, **validation_options
+        end
+      end
+
+      def interpret_extra_to(_model, _accessibility, _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,26 @@
+module FormCore::Concerns
+  module Models
+    module Form
+      extend ActiveSupport::Concern
+
+      included do
+        has_many :fields
+      end
+
+      DEFAULT_MODEL_NAME = "Form"
+      DEFAULT_FIELDS_SCOPE = proc { |fields| fields }
+      def to_virtual_model(model_name: DEFAULT_MODEL_NAME,
+                           fields_scope: DEFAULT_FIELDS_SCOPE,
+                           overrides: {})
+        model = Class.new(FormCore.virtual_model_class)
+        model.model_name = model_name
+
+        fields_scope.call(fields).each do |f|
+          f.interpret_to model, overrides: overrides.fetch(f.name, {})
+        end
+
+        model
+      end
+    end
+  end
+end

data/lib/form_core/engine.rb

@@ -0,0 +1,5 @@
+module FormCore
+  class Engine < ::Rails::Engine
+    isolate_namespace FormCore
+  end
+end

data/lib/form_core/version.rb

@@ -0,0 +1,3 @@
+module FormCore
+  VERSION = '0.0.1'
+end

data/lib/form_core/virtual_model.rb

@@ -0,0 +1,12 @@
+require "duck_record"
+
+module FormCore
+  class VirtualModel < ::DuckRecord::Base
+    public_class_method :define_method
+    class << self
+      def model_name=(name)
+        @_model_name = ActiveModel::Name.new(self, nil, name.classify)
+      end
+    end
+  end
+end

data/lib/tasks/form_core_tasks.rake

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

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: form_core
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- jasl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-30 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'
+- !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'
+description: |
+  A Rails engine provides 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
+- app/models/form_core/application_record.rb
+- app/models/form_core/field.rb
+- app/models/form_core/form.rb
+- db/migrate/20170430190404_create_form_core_forms.rb
+- db/migrate/20170430191336_create_form_core_fields.rb
+- lib/form_core.rb
+- lib/form_core/concerns/models/field.rb
+- lib/form_core/concerns/models/form.rb
+- lib/form_core/engine.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 provides ability to generate dynamic form.
+test_files: []