action_blocks 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a75a9346f84e224424ecd5353246ad7add3cf51236db4582edad2195e1e5ee5e
+  data.tar.gz: a63d8109813b23def1edbae53957734b135a835b8670ea2cf7698f7cf889e5c1
+SHA512:
+  metadata.gz: dec0b245ea8c07e74fcc1bad08152b02b581cb84a5fa19b222041a5fb7a75f55da43c11d49a9bd66d9eec80f604929468cd4a99afbeab7050e5020db388d3dc8
+  data.tar.gz: 38360d45575e3c1672668301867391dcfd80674b37c61395e49abc12789c01ca63596c08313e9fff3044c4ebbc5fc6bc16aefb04f74075da78828308fa951df7

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 CTEH LLC
+
+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,121 @@
+# ActionBlocks
+[![Travis](https://travis-ci.org/CTEH/action_blocks.svg?branch=master)](https://travis-ci.org/CTEH/action_blocks)
+
+ActionBlocks is a Ruby On Rails engine for building administrative database-driven applications.
+
+* Automates Backend and Frontend Development
+
+* Supports Granular Authorization
+
+* Leverages PostgreSQL for Performance
+
+* Encourages Task Oriented UI
+
+
+Automates Backend and Frontend Development
+-------------------
+
+A single low-code DSL is used to define both the backend and frontend.
+
+![ActionBlocks Diagram](https://raw.githubusercontent.com/CTEH/action_blocks/master/docs/single_dsl_diagram.png)
+
+```ruby
+ActionBlocks.app do
+  title "My App"
+  workspace :main do
+    subspace :orders  do
+      dashboard :all_orders do
+        table :list_all do
+          model :order
+          columns [:number, :employee, :customer, :status]
+        end
+      end
+
+...
+```
+
+Supports Granular Authorization
+----------
+
+Row Level Security (RLS) is defined for each role.
+
+```ruby
+ActionBlock.authorize Post do
+    grant :reviewer do
+        _or(
+            _eq(:author_id, _user(:id)),
+            _eq(:status, 'Published')
+        ),
+    end
+end
+```
+
+Field Level Security (FLS) is defined for each role.
+
+```ruby
+read do
+    read :employee,          [:admin           ]
+    read :customer,          [:admin, :customer]
+    read :social_security    [:admin, :customer]
+    read :order_date,        [:admin, :customer]
+    read :shipped_date,      [:admin, :customer]
+    read :ship_name,         [:admin, :customer]
+    read :ship_address1,     [:admin, :customer]
+    read :ship_address2,     [:admin, :customer]
+    read :ship_city,         [:admin, :customer]
+    read :ship_state,        [:admin, :customer]
+    read :ship_postal_code,  [:admin, :customer]
+    read :ship_country,      [:admin, :customer]
+    read :shipping_fee,      [:admin, :customer]
+    read :payment_type,      [:admin, :customer]
+    read :paid_date,         [:admin, :customer]
+    read :created_at,        [:admin, :customer]
+    read :updated_at,        [:admin, :customer]
+    read :region,            [:admin, :customer]
+    read :referred_by,       [:admin, :customer]
+end
+
+```
+
+
+
+Leverages PostgreSQL for Performance
+------------
+
+ActionBlocks is similar to [Hasura](https://blog.hasura.io/architecture-of-a-high-performance-graphql-to-sql-server-58d9944b8a87) since it avoids N+1 queries and pushes JSON generation into PostgreSQL
+
+* Uses an intelligent DSL managed data engine that avoids the N+1 problem associated with retrieving data in related tables and running authorization checks.
+
+* Bypasses the performance tax of marshalling results to Objects and ultimately to JSON by pushing the transformation into PostgreSQL.
+
+Encourages Task Oriented UI
+------------
+
+Following the pholisophy of make the right thing the easy thing, ActionBlocks doesn't support CRUD.  Instead it provides a rich DSL for Task Oriented UIs as explained https://cqrs.wordpress.com/documents/task-based-ui/
+
+
+
+## License
+MIT License
+
+Copyright (c) 2018 CTEH LLC
+
+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,33 @@
+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    = 'ActionBlocks'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/north_winds/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
+  t.warning = false
+end
+
+task default: :test

data/app/assets/config/action_blocks.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/action_blocks .js
+//= link_directory ../stylesheets/action_blocks .css

data/app/assets/javascripts/action_blocks/application.js

@@ -0,0 +1,15 @@
+// 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. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require activestorage
+//= require_tree .

data/app/assets/stylesheets/action_blocks/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/action_blocks/attachments_controller.rb

@@ -0,0 +1,22 @@
+module ActionBlocks
+  class AttachmentsController < ActionController::Base
+      before_action :authenticate_user!
+
+      def download
+        model = ActionBlocks.find(params[:model_key])
+        if model == nil
+          raise RecordNotFound
+        end
+        id = params[:id]
+        field = params[:field]
+        record = model.active_model.find(id)
+        attachment = record.send(field)
+        begin
+          send_data attachment.download
+        rescue Module::DelegationError
+          raise ActiveRecord::RecordNotFound
+        end
+      end
+
+  end
+end

data/app/controllers/action_blocks/barchart_blocks_controller.rb

@@ -0,0 +1,14 @@
+module ActionBlocks
+  class BarchartBlocksController < ActionBlocks::BaseController
+    before_action :authenticate_user!
+
+    def analytics
+      block = ActionBlocks.find(params[:block_key])
+      user = nil
+      if block.calculate == :count
+        render plain: block.scope.call().group(block.group.column).count.to_json
+      end
+    end
+
+  end
+end

data/app/controllers/action_blocks/base_controller.rb

@@ -0,0 +1,22 @@
+module ActionBlocks
+
+  class BaseController < ApplicationController
+    # Disable need for authenticity token as we
+    # we are integrating with clients not rendered by rails
+
+    # JRH - https://labs.chiedo.com/blog/authenticating-your-reactjs-app-with-devise-no-extra-gems-needed/
+
+    before_action :validate_action_block
+    def validate_action_block
+      if Rails.env.development? || Rails.env.test?
+        if ActionBlocks.invalid?
+          Rails.logger.error "ActionBlock application invalid"
+          Rails.logger.error ActionBlocks.errors
+          raise "ActionBlock application invalid #{ActionBlocks.errors}"
+        end
+      end
+    end
+
+  end
+
+end

data/app/controllers/action_blocks/blocks_controller.rb

@@ -0,0 +1,16 @@
+module ActionBlocks
+  class BlocksController < BaseController
+    before_action :authenticate_user!
+    skip_before_action :validate_action_block
+
+    def index
+      user = nil
+      if ActionBlocks.invalid?
+        render json: {errors: ActionBlocks.errors}.to_json, content_type: 'application/json'
+      else
+        render json: ActionBlocks.hashify(user).to_json, content_type: 'application/json'
+      end
+    end
+
+  end
+end

data/app/controllers/action_blocks/command_blocks_controller.rb

@@ -0,0 +1,6 @@
+module ActionBlocks
+  class CommandBlocksController < BaseController
+      before_action :authenticate_user!
+
+  end
+end

data/app/controllers/action_blocks/form_blocks_controller.rb

@@ -0,0 +1,13 @@
+module ActionBlocks
+
+  class FormBlocksController < ActionBlocks::BaseController
+      before_action :authenticate_user!
+
+      def record
+        form = ActionBlocks.find(params[:block_key])
+        record_id = Integer(params[:record_id])
+        render json: form.record_to_json(user: current_user, record_id: record_id)
+      end
+
+  end
+end

data/app/controllers/action_blocks/model_blocks_controller.rb

@@ -0,0 +1,13 @@
+module ActionBlocks
+
+  class ModelBlocksController < ActionBlocks::BaseController
+    before_action :authenticate_user!
+
+    def name
+      model_block = ActionBlocks.find(params[:block_key])
+      record_id = Integer(params[:record_id])
+      render json: model_block.name_to_json(record_id: record_id, user: current_user)
+    end
+  end
+
+end

data/app/controllers/action_blocks/table_blocks_controller.rb

@@ -0,0 +1,13 @@
+module ActionBlocks
+  class TableBlocksController < ActionBlocks::BaseController
+    before_action :authenticate_user!
+
+    def records
+      params.permit([:block_key, :subspace_model_id, :dashboard_model_id])
+      user = current_user
+      table = ActionBlocks.find(params[:block_key])
+      render json: table.to_json(user: current_user, params: params)
+    end
+
+  end
+end

data/app/controllers/action_blocks/workspace_blocks_controller.rb

@@ -0,0 +1,6 @@
+module ActionBlocks
+  class WorkspaceBlocksController < ActionBlocks::BaseController
+      before_action :authenticate_user!
+
+  end
+end

data/app/helpers/action_blocks/application_helper.rb

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

data/app/jobs/action_blocks/application_job.rb

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

data/app/mailers/action_blocks/application_mailer.rb

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

data/app/models/action_blocks/application_record.rb

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

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

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Active blocks</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "action_blocks/application", media: "all" %>
+  <%= javascript_include_tag "action_blocks/application" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/initializers/action_blocks.rb

@@ -0,0 +1,9 @@
+def database_exists?
+    ActiveRecord::Base.connection
+rescue ActiveRecord::NoDatabaseError
+    false
+else
+    true
+end
+
+ActionBlocks.initial_load if database_exists?

data/config/routes.rb

@@ -0,0 +1,10 @@
+ActionBlocks::Engine.routes.draw do
+  get "action_blocks/blocks", to: "blocks#blocks"
+  get "table_blocks/:block_key(/:subspace_model_id)(/:dashboard_model_id)/records", to: "table_blocks#records"
+  get "form_blocks/:block_key/:record_id/record", to: "form_blocks#record"
+  get "blocks", to: "blocks#index"
+  get "barchart_blocks/:block_key/analytics", to: "barchart_blocks#analytics"
+  get "model_blocks/:block_key/:record_id/name", to: "model_blocks#name"
+  get 'attachments/:model_key/:id/:field' => "attachments#download"
+
+end

data/lib/action_block_loader.rb

@@ -0,0 +1,120 @@
+# require 'active_admin/reloader'
+
+module ActionBlocks
+  class Loader
+
+    attr_reader :application, :load_paths
+    def initialize(path)
+      @load_paths = [File.expand_path(path, Rails.root)]
+    end
+
+    # Whether all configuration files have been loaded
+     def loaded?
+       @@loaded ||= false
+     end
+
+     # Removes all defined controllers from memory. Useful in
+     # development, where they are reloaded on each request.
+     def unload!
+       ActionBlocks.unload!
+       @@loaded = false
+     end
+
+     # Loads all ruby files that are within the load_paths setting.
+     # To reload everything simply call `ActionBlocks.unload!`
+     def load!
+       Rails.logger.debug "ActionBlocks::Loader load!()"
+       Rails.logger.debug " loaded?:#{loaded?().inspect}"
+       unless loaded?
+         # ActiveSupport::Notifications.publish BeforeLoadEvent, self # before_load hook
+         files.each{ |file| load file }                             # load files
+         # ActiveSupport::Notifications.publish AfterLoadEvent, self  # after_load hook
+         @@loaded = true
+       end
+     end
+
+     def load(file)
+       Rails.logger.debug "ActionBlocks::Loader load(#{file})"
+       DatabaseHitDuringLoad.capture{ super }
+     end
+
+     # Returns ALL the files to be loaded
+     def files
+       load_paths.flatten.compact.uniq.flat_map{ |path| Dir["#{path}/**/*.rb"] }
+     end
+
+    # Since app/blocks is alphabetically before app/models, we have to remove it
+    # from the host app's +autoload_paths+ to prevent missing constant errors.
+    #
+    # As well, we have to remove it from +eager_load_paths+ to prevent the
+    # files from being loaded twice in production.
+    def remove_active_admin_load_paths_from_rails_autoload_and_eager_load
+      ActiveSupport::Dependencies.autoload_paths -= load_paths
+      Rails.application.config.eager_load_paths  -= load_paths
+    end
+
+    # Hook into the Rails code reloading mechanism so that things are reloaded
+    # properly in development mode.
+    #
+    # If any of the app files (e.g. models) has changed, we need to reload all
+    # the admin files. If the admin files themselves has changed, we need to
+    # regenerate the routes as well.
+    def attach_reloader
+      # ActiveSupport::Reloader.to_prepare(*args, &block)
+      Rails.application.config.after_initialize do |app|
+          if app.config.reload_classes_only_on_change
+            # Rails is about to unload all the app files (e.g. models), so we
+            # should first unload the classes generated by Active Admin, otherwise
+            # they will contain references to the stale (unloaded) classes.
+            ActiveSupport::Reloader.to_prepare(prepend: true) do
+              ActionBlocks.unload!
+            end
+          else
+            # If the user has configured the app to always reload app files after
+            # each request, so we should unload the generated classes too.
+            ActiveSupport::Reloader.to_complete() do
+              puts "ActiveSupport::Reloader.to_complete()\n"
+              # ActionBlocks.application.unload!
+              # @@loaded = false
+            end
+          end
+
+          # block_drs = {}
+          #
+          # load_paths.each do |path|
+          #   block_drs[path] = [:rb]
+          # end
+
+          # routes_reloader = app.config.file_watcher.new([], block_drs) do
+          #   app.reload_routes!
+          # end
+          #
+          # app.reloaders << routes_reloader
+
+          ActiveSupport::Reloader.to_prepare do
+            # Rails.logger.debug("--> 1. ActionBlocks::Loader.new('app/blocks')")
+            loader = ActionBlocks::Loader.new('app/blocks')
+            loader.unload!
+            loader.load!
+            ActionBlocks.after_load
+
+            # loader.attach_reloader
+            # Rails might have reloaded the routes for other reasons (e.g.
+            # routes.rb has changed), in which case Active Admin would have been
+            # loaded via the `ActiveAdmin.routes` call in `routes.rb`.
+            #
+            # Otherwise, we should check if any of the admin files are changed
+            # and force the routes to reload if necessary. This would again causes
+            # Active Admin to load via `ActiveAdmin.routes`.
+            #
+            # Finally, if Active Admin is still not loaded at this point, then we
+            # would need to load it manually.
+            # unless ActionBlocks.application.loaded?
+              # routes_reloader.execute_if_updated
+              # self.load!
+            # end
+          end
+        end
+    end #attach_reloader
+  end
+end