mechanical 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3e83b7b9b4b6d26db4fe167d18290da402ca50c191170b27d23d5c4ae48e351d
+  data.tar.gz: f0b2bc0445a468092dc78bd5f7e18eb0018da1c6bbb0605cf692dcf34043c8a5
+SHA512:
+  metadata.gz: b774147facef799a28e82e668dea5381f3eeeccc4851e4d5df200c12e13f8ec73f94671c3dfd01b5700a29594bcfea412f08538fb995b70d66b0d1220c20f140
+  data.tar.gz: 7ad53cb8c2d72f09fe21b18932f3465187a058ff56bb620522941b4a49738313221fa221f4471994e158d8aa78fc058afd5a11e431b9efe8f1d10ab54d972915

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Igor Kasyanchuk
+
+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,149 @@
+# Mechanical
+
+Simple gem which allows to store multiple models in a single table in DB (Postgres only). It's using STI and Postgres JSONB data type.
+
+The whole schema is defined in one initializer file, and new attributes could be easily added just by adding new attribute in that file. So you don't need to create a migration.
+
+## Usage
+
+- add in the Gemfile `gem "mechanical"`
+- execute `bundle install`
+- execute `rails g mechanical initializer`
+- execute `rake db:migrate`
+- edit `config/initializers/mechanical.rb` and define your schema
+- start app `rails s`
+- you can use models `Mechanical::Model::MODEL_NAME` in you app like a regular model.
+
+You need to define attribute and it's type (it's importan to check this gem: https://github.com/madeintandem/jsonb_accessor).
+In addition you can specify relations, validations, add instance or class methods. Behavior is the same as with AR model.
+
+```ruby
+
+Mechanical.setup do |config|
+
+  model "Account" do
+    field :name, type: :string
+    field :balance, type: :integer
+
+    has_many :posts
+
+    validates :name, presence: true
+    validates :balance, numericality: true
+  end
+
+  model "Post" do
+    field :title, type: :string
+    field :description, type: :text
+    field :published_on, type: :date
+    field :account_id, type: :integer
+    field :active, type: :boolean, default: true
+
+    belongs_to :account, optional: true
+
+    has_one_attached :file
+
+    validates :title, presence: true
+
+    scope :active, -> { jsonb_where(:mechanical_data, active: true) }
+
+    after_create :say_hello
+
+    add_methods do
+      def self.total_posts
+        self.count
+      end
+
+      def title_uppercase
+        title&.upcase
+      end
+
+      def say_hello
+        puts "HELLO FROM initializer #{self}"
+      end
+    end
+  end
+
+end
+```
+
+After Installation you can do the following:
+
+```ruby
+  post = Mechanical::Model::Post.create(title: "Hello world", description: "this is description")
+  post.persisted? # true
+
+  post.title # "Hello world"
+  post.description # "this is description"
+
+  # for querying use: https://github.com/madeintandem/jsonb_accessor
+
+  Mechanical::Model::Post.create(title: "ABC", description: "this is description")
+  Mechanical::Model::Post.create(title: "TRE", description: "this is second description")
+  Mechanical::Model::Account.create(name: "XYZ", balance: 100)
+  Mechanical::Model::Account.create(name: "MTR", balance: 200)
+  Mechanical::Model::Post.jsonb_where(:mechanical_data, { title: 'ABC' }).count # 1
+  Mechanical::Model::Account.mechanical_data_where(balance: { greater_than_or_equal_to: 150 }).count # 1
+  Mechanical::Model::Account.mechanical_data_where(balance: 10..250).count # 2
+```
+
+If you are building form and want to use this model you can do it same way as using regular model:
+
+Example of very simple controller:
+
+```ruby
+  def index
+    @post  = Mechanical::Model::Post.new
+  end
+
+  def submit_post
+    @post = Mechanical::Model::Post.new(params.require(:post).permit!)
+    @post.user = User.first
+    @post.save
+    if @post.save
+      redirect_to root_path
+    else
+      @posts = Mechanical::Model::Post.all
+      render :index
+    end
+  end
+```
+
+View:
+
+```erb
+
+<%= simple_form_for @post, url: submit_post_url, html: { novalidate: true } do |f| %>
+  <%= f.error_messages %>
+  <%= f.association :account %>
+  <%= f.input :title %>
+  <%= f.input :description %>
+  <%= f.input :published_on %>
+  <%= f.input :file %>
+  <%= f.input :active %>
+  <br/>
+  <%= f.submit %>
+<% end %>
+
+```
+
+As you can see it supports active storage.
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mechanical'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+## Contributing
+
+You are welcome to contribute.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,32 @@
+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    = 'Mechanical'
+  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", __dir__)
+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/assets/config/mechanical_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/mechanical .css

data/app/assets/stylesheets/mechanical/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 other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/mechanical/application_controller.rb

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

data/app/helpers/mechanical/application_helper.rb

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

data/app/jobs/mechanical/application_job.rb

@@ -0,0 +1,4 @@
+module Mechanical
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/mechanical/application_mailer.rb

@@ -0,0 +1,6 @@
+module Mechanical
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/mechanical/application_record.rb

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

data/app/models/mechanical/mechanical_store.rb

@@ -0,0 +1,4 @@
+module Mechanical
+  class MechanicalStore < ApplicationRecord
+  end
+end

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

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Mechanical</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "mechanical/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/initializers/mechanical.rb

@@ -0,0 +1,47 @@
+if Object.const_defined?('Mechanical')
+
+  Mechanical.setup do |config|
+    # model "Account" do
+    #   field :name, type: :string
+    #   field :balance, type: :integer
+  
+    #   has_many :posts
+  
+    #   validates :name, presence: true
+    #   validates :balance, numericality: true
+    # end
+  
+    # model "Post" do
+    #   field :title, type: :string
+    #   field :description, type: :text
+    #   field :published_on, type: :date
+    #   field :account_id, type: :integer
+    #   field :active, type: :boolean, default: true
+  
+    #   belongs_to :account, optional: true
+  
+    #   has_one_attached :file
+  
+    #   validates :title, presence: true
+  
+    #   scope :active, -> { jsonb_where(:mechanical_data, active: true) }
+  
+    #   after_create :say_hello
+  
+    #   add_methods do
+    #     def self.total_posts
+    #       self.count
+    #     end
+  
+    #     def title_uppercase
+    #       title&.upcase
+    #     end
+  
+    #     def say_hello
+    #       puts "HELLO FROM initializer #{self}"
+    #     end
+    #   end
+    # end
+  end
+
+end

data/config/routes.rb

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

data/db/migrate/20190912181342_create_mechanical_mechanical_stores.rb

@@ -0,0 +1,17 @@
+class CreateMechanicalMechanicalStores < ActiveRecord::Migration[6.0]
+  def change
+    create_table :mechanical_mechanical_stores do |t|
+      t.integer :mechanicalable_id
+      t.string :mechanicalable_type
+
+      t.integer :mechanical_user_id
+      t.string :mechanical_model_type
+      t.jsonb :mechanical_data, default: {}
+      t.timestamps
+    end
+
+    add_index :mechanical_mechanical_stores, :mechanical_user_id
+    add_index :mechanical_mechanical_stores, :mechanical_model_type
+    add_index :mechanical_mechanical_stores, [:mechanicalable_id, :mechanicalable_type], name: :____mmidtype
+  end
+end

data/lib/generators/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Generate configuration file.
+
+Example:
+    rails generate mechanical initializer
+
+    This will create:
+        - config/mechanical.rb
+        - new mechanical migration

data/lib/generators/mechanical_generator.rb

@@ -0,0 +1,7 @@
+class MechanicalGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+  def copy_initializer
+    template 'mechanical.rb', 'config/initializers/mechanical.rb'
+    template '20190912181342_create_mechanical_mechanical_stores.rb', "db/migrate/#{Time.now.strftime('%Y%m%d%H%M%S')}_create_mechanical_mechanical_stores.rb"
+  end
+end

data/lib/generators/templates/20190912181342_create_mechanical_mechanical_stores.rb

@@ -0,0 +1,17 @@
+class CreateMechanicalMechanicalStores < ActiveRecord::Migration[6.0]
+  def change
+    create_table :mechanical_mechanical_stores do |t|
+      t.integer :mechanicalable_id
+      t.string :mechanicalable_type
+
+      t.integer :mechanical_user_id
+      t.string :mechanical_model_type
+      t.jsonb :mechanical_data, default: {}
+      t.timestamps
+    end
+
+    add_index :mechanical_mechanical_stores, :mechanical_user_id
+    add_index :mechanical_mechanical_stores, :mechanical_model_type
+    add_index :mechanical_mechanical_stores, [:mechanicalable_id, :mechanicalable_type], name: :____mmidtype
+  end
+end

data/lib/generators/templates/mechanical.rb

@@ -0,0 +1,47 @@
+if Object.const_defined?('Mechanical')
+
+  Mechanical.setup do |config|
+    # model "Account" do
+    #   field :name, type: :string
+    #   field :balance, type: :integer
+  
+    #   has_many :posts
+  
+    #   validates :name, presence: true
+    #   validates :balance, numericality: true
+    # end
+  
+    # model "Post" do
+    #   field :title, type: :string
+    #   field :description, type: :text
+    #   field :published_on, type: :date
+    #   field :account_id, type: :integer
+    #   field :active, type: :boolean, default: true
+  
+    #   belongs_to :account, optional: true
+  
+    #   has_one_attached :file
+  
+    #   validates :title, presence: true
+  
+    #   scope :active, -> { jsonb_where(:mechanical_data, active: true) }
+  
+    #   after_create :say_hello
+  
+    #   add_methods do
+    #     def self.total_posts
+    #       self.count
+    #     end
+  
+    #     def title_uppercase
+    #       title&.upcase
+    #     end
+  
+    #     def say_hello
+    #       puts "HELLO FROM initializer #{self}"
+    #     end
+    #   end
+    # end
+  end
+
+end

data/lib/mechanical.rb

@@ -0,0 +1,95 @@
+require "mechanical/engine"
+require 'simple_form'
+require 'ostruct'
+require 'jsonb_accessor'
+
+module Mechanical
+  class Schema
+    attr_reader :models
+
+    def initialize
+      @models = {}
+    end
+
+    def model(name, &block)
+      model = Model.new(name)
+      model.instance_eval(&block)
+      @models[name] = model
+    end
+
+    def [](name)
+      @models[name]
+    end
+  end
+
+  class Field
+    attr_reader :name, :options, :model
+
+    def initialize(model, name, options = {})
+      @model   = model
+      @name    = name
+      @options = options
+      model.model.jsonb_accessor :mechanical_data, name.to_sym => [options[:type].presence || String, default: options[:default]]
+    end
+
+    def validates(options = {})
+      model.model.send :validates, name.to_sym, options
+    end
+
+  end
+
+  class Model
+    attr_reader :fields, :name, :options, :model
+
+    delegate_missing_to :model
+
+    def initialize(name, options = {})
+      @name    = name
+      @fields  = {}
+      @options = options
+      @model   = eval %{
+        class #{name} < ApplicationRecord
+          self.table_name = "mechanical_mechanical_stores"
+          def self.model_name; ActiveModel::Name.new(self, nil, "#{name.downcase}"); end
+
+          default_scope -> { where(mechanical_model_type: name) }
+
+          belongs_to :user, optional: true, foreign_key: :mechanical_user_id
+          belongs_to :mechanicalable, polymorphic: true, optional: true
+        end
+        #{name}
+      }
+
+      puts "Mechanical init model => #{@model}"
+    end
+    
+    def field(name, options = {}, &block)
+      @fields[name] = Field.new(self, name, options)
+    end
+
+    def add_methods(&block)
+      @model.class_eval(&block)
+    end
+  end
+
+  mattr_accessor :schema
+  @@schema = Schema.new
+  
+  def self.setup(&block)
+    setup_active_storage
+    schema.instance_eval(&block)
+  end
+
+  def self.[](name)
+    schema[name]
+  end
+
+  private
+
+  def self.setup_active_storage
+    ApplicationRecord.send :include, ActiveStorage::Reflection::ActiveRecordExtensions
+    ApplicationRecord.send :include, ActiveStorage::Attached::Model
+    ::ActiveRecord::Reflection.singleton_class.prepend(::ActiveStorage::Reflection::ReflectionExtension)
+  end
+
+end

data/lib/mechanical/engine.rb

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

data/lib/mechanical/version.rb

@@ -0,0 +1,3 @@
+module Mechanical
+  VERSION = '0.1.0'
+end

data/lib/tasks/mechanical_tasks.rake

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

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: mechanical
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Igor Kasyanchuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-08 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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: simple_form
+  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: jsonb_accessor
+  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: pg
+  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: pry
+  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: image_processing
+  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: mini_magick
+  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: Dynamic forms, schema, everything stored in DB
+email:
+- igorkasyanchuk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/mechanical_manifest.js
+- app/assets/stylesheets/mechanical/application.css
+- app/controllers/mechanical/application_controller.rb
+- app/helpers/mechanical/application_helper.rb
+- app/jobs/mechanical/application_job.rb
+- app/mailers/mechanical/application_mailer.rb
+- app/models/mechanical/application_record.rb
+- app/models/mechanical/mechanical_store.rb
+- app/views/layouts/mechanical/application.html.erb
+- config/initializers/mechanical.rb
+- config/routes.rb
+- db/migrate/20190912181342_create_mechanical_mechanical_stores.rb
+- lib/generators/USAGE
+- lib/generators/mechanical_generator.rb
+- lib/generators/templates/20190912181342_create_mechanical_mechanical_stores.rb
+- lib/generators/templates/mechanical.rb
+- lib/mechanical.rb
+- lib/mechanical/engine.rb
+- lib/mechanical/version.rb
+- lib/tasks/mechanical_tasks.rake
+homepage: https://github.com/igorkasyanchuk/mechanical
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Forms / DB / Model
+test_files: []