tb_heavy_control 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a54ae4567638a77de15d4cc8f98a30b1d7876cfa
+  data.tar.gz: 498f1fda13c24131e900a03486b3a118ecfb80a5
+SHA512:
+  metadata.gz: e648b9921f00750eb394ab91362f9dcdf7feeaf8d90a274b1898a0452990018deeccc5fea61f194f2cd48c864dd63530a630bc9811a94dc1ac52d84cd6b5f1a2
+  data.tar.gz: a99c26d484770f5adac5f5ec5ecae2c237ae0ae52e3e417645f93954180cf49566372ce79bc011b8e1c7c9284133ec8c337ac09761316c3c91447c3e91be461d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Roman Kolesnev
+
+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.rdoc

@@ -0,0 +1,3 @@
+= TbHeavyControl
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,34 @@
+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    = 'TbHeavyControl'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/tasks/tb_heavy_control_tasks.rake

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

data/lib/tb_heavy_control/configurable.rb

@@ -0,0 +1,89 @@
+module TbHeavyControl
+  module Configurable
+    CONST_CHECK_SKIP = %w(operations views concepts).freeze
+
+    attr_reader :pipeline
+
+    def config(&block)
+      raise 'tb_heavy_control config cannot run without block' if block.nil?
+      @pipeline ||= [] # Pathname means load file, String - check constant
+      @context = Rails.root.join('app', 'concepts')
+
+      instance_eval(&block)
+    end
+
+    def debug(arg = nil)
+      @debug = arg unless arg.nil?
+      @debug
+    end
+
+    private
+
+    # DSL methods
+
+    def getrb(original_path)
+      array_form = normalize(original_path)
+
+      last = array_form.last
+      array_form[-1] = last + '.rb' if last[-3..-1] != '.rb'
+
+      path = @context.join(*array_form)
+      raise "Cannot find file: #{path}" unless path.file?
+
+      @pipeline << path unless @pipeline.include?(path)
+    end
+
+    def context(path)
+      previous_context = @context
+      @context = previous_context.join(*normalize(path))
+      raise "#{@context} isn't a directory" unless @context.directory?
+      check_constant_for(@context)
+      yield
+      @context = previous_context
+    end
+
+    def folder(original_path = '')
+      folder = @context.join(*normalize(original_path))
+      raise "#{folder} isn't a directory" unless folder.directory?
+
+      rb_files = folder.children.select { |pn| pn.extname == '.rb' }
+      check_constant_for(folder) if rb_files.any?
+      rb_files.each { |file| getrb file }
+    end
+
+    def recursive(original_path = '', reverse: false)
+      folder = @context.join(*normalize(original_path))
+      raise "#{folder} isn't a directory" unless folder.directory?
+
+      folder original_path unless reverse
+      context original_path do
+        # exclude '.' and '..' entries
+        folder.children.select(&:directory?).each do |child_folder|
+          next if child_folder.basename == 'views'
+          recursive child_folder.basename, reverse: reverse
+        end
+      end
+      folder original_path if reverse
+    end
+
+    # Helper methods
+
+    def check_constant_for(folder) # rubocop:disable Metrics/AbcSize (15.5)
+      return if CONST_CHECK_SKIP.include? folder.basename.to_s
+
+      subpath = []
+      while folder.basename.to_s != 'concepts'
+        subpath << folder.basename
+        folder = folder.parent
+      end
+
+      const_name = subpath.reverse.map(&:to_s).map(&:camelize).join('::')
+
+      @pipeline << const_name unless @pipeline.include? const_name
+    end
+
+    def normalize(arg)
+      Array(arg).map(&:to_s)
+    end
+  end
+end

data/lib/tb_heavy_control/loader.rb

@@ -0,0 +1,41 @@
+module TbHeavyControl
+  module Loader
+    class << self
+      def call
+        @order = TbHeavyControl.pipeline
+        @order.each do |entry|
+          case entry
+          when Pathname then load_file(entry.to_s)
+          when String   then check_constant(entry)
+          end
+        end
+      end
+
+      private
+
+      def load_file(file)
+        Rails.logger.debug "tb_heavy_control: load file '#{file}'" if TbHeavyControl.debug
+        require_dependency file
+      end
+
+      def check_constant(const_name)
+        Rails.logger.debug "tb_heavy_control: check constant '#{const_name}'" if TbHeavyControl.debug
+        const_name.constantize
+      rescue NameError
+        parent = resolve_parent(const_name)
+
+        new_module_name = const_name.demodulize
+        Rails.logger.debug "tb_heavy_control: create module '#{const_name}'" if TbHeavyControl.debug
+        parent.const_set(new_module_name, Module.new)
+      end
+
+      def resolve_parent(const_name)
+        parent_str = const_name.deconstantize
+        case parent_str
+        when '', '::' then Object
+        else parent_str.constantize
+        end
+      end
+    end
+  end
+end

data/lib/tb_heavy_control/railtie.rb

@@ -0,0 +1,36 @@
+require 'tb_heavy_control/loader'
+
+module TbHeavyControl
+  class Railtie < Rails::Railtie
+    def self.concepts_loader(_app)
+      TbHeavyControl::Loader.call
+    end
+
+    # initializer 'tb_heavy_control.disable_eager_loading', before: :set_load_path do |app|
+    #   path = app.root.join('app', 'concepts').to_s
+    #
+    #   app.config.eager_load_paths -= [path]
+    # end
+
+    # this initializer is a copy from trailblazer-rails gem
+    initializer 'tb_heavy_control.trailblazer-rails_stuff' do
+      require 'trailblazer/autoloading'
+
+      require 'trailblazer/operation/model'
+      require 'trailblazer/operation/model/active_model'
+      Trailblazer::Operation::Model::DSL.module_eval do
+        include Trailblazer::Operation::Model::ActiveModel # ::contract.
+      end
+
+      Trailblazer::Operation.class_eval do
+        autoload :Responder, 'trailblazer/operation/responder'
+      end
+    end
+
+    initializer 'tb_heavy_control.concepts_loader', after: :load_config_initializers do |app|
+      ActionDispatch::Reloader.to_prepare do
+        TbHeavyControl::Railtie.concepts_loader(app)
+      end
+    end
+  end
+end

data/lib/tb_heavy_control/version.rb

@@ -0,0 +1,3 @@
+module TbHeavyControl
+  VERSION = '0.0.1'.freeze
+end

data/lib/tb_heavy_control.rb

@@ -0,0 +1,19 @@
+require 'tb_heavy_control/configurable'
+
+module TbHeavyControl
+  extend TbHeavyControl::Configurable
+end
+
+require 'tb_heavy_control/railtie'
+
+# stuff below is copy from trailblazer-rails gem
+# stuff inside lib/trailblazer folder too =)
+
+require 'trailblazer/operation'
+# TODO: remove that once i18n, validations etc in Reform/AM are sorted.
+Trailblazer::Operation.contract_class.class_eval do
+  def self.name
+    # for whatever reason, validations climb up the inheritance tree and require _every_ class to have a name (4.1).
+    'Reform::Form'
+  end
+end

data/lib/trailblazer/operation/controller/active_record.rb

@@ -0,0 +1,21 @@
+# Assigns an additional instance variable for +@model+ named after the model's table name (e.g. @comment).
+#
+# THIS MODULE IS DEPRECATED!
+#
+# Please don't use this module. Instead, use @model in your controller or pass the 
+# operation instance to a cell to present it.
+module Trailblazer::Operation::Controller::ActiveRecord
+private
+  def setup_operation_instance_variables!(operation, options)
+    super
+    instance_variable_set(:"@#{operation_model_name}", @model)
+  end
+
+  def operation_model_name
+    # set the right variable name if collection
+    if @operation.is_a?(Trailblazer::Operation::Collection)
+      return @model.model.table_name.split(".").last
+    end
+    @model.class.table_name.split(".").last.singularize
+  end
+end

data/lib/trailblazer/operation/model/active_model.rb

@@ -0,0 +1,11 @@
+module Trailblazer
+  module Operation::Model
+    # Automatically set model_name on operation's contract.
+    module ActiveModel
+      def contract(*, &block)
+        super
+        contract_class.model(model_class) # this assumes that Form::ActiveModel is mixed in.
+      end
+    end
+  end
+end

data/lib/trailblazer/operation/responder.rb

@@ -0,0 +1,23 @@
+module Trailblazer::Operation::Responder
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def model_name
+      model_class.model_name
+    end
+  end
+
+  extend Forwardable
+  def_delegators :@model, :to_param, :destroyed?, :persisted?
+
+  def errors
+    return [] if @valid
+    [1]
+  end
+
+  def to_model
+    @model
+  end
+end

data/lib/trailblazer/operation/worker.rb

@@ -0,0 +1,112 @@
+require 'sidekiq/worker'
+require 'active_support/core_ext/hash/indifferent_access'
+
+#setup in initialize: when Op.run() with Worker, the policy will be run "delayed" and not with the actual permission set. this will result in many crashing sidekiq workers.
+
+class Trailblazer::Operation
+  # only kicks in when Operation::run, #run will still do it real-time
+  # Works with Reform 2, only.
+  module Worker
+    def self.included(base)
+      base.send(:include, Sidekiq::Worker)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def run(params)
+        if background?
+          return perform_async(serializable(params))
+        end
+
+        super(params)
+      end
+
+      def new(*args)
+        return super if args.any?
+        # sidekiq behavior: (not a big fan of this)
+        self
+      end
+
+      def perform(params) # called by Sidekiq.
+        build_operation(params).perform
+      end
+
+      def jid=(jid)
+        puts "@@@@@ #{jid.inspect}"
+      end
+
+    private
+      def perform_async(*args)
+        client_push('class' => self, 'args' => args) # calls class.new.perform(params)
+      end
+
+      def background? # TODO: make configurable.
+        true
+        # if Rails.env == "production" or Rails.env == "staging"
+      end
+
+      def serializable(params)
+        params # this is where we convert file uloads into Trailblazer::UploadedFile, etc. soon.
+      end
+    end
+
+
+    def perform#(params)
+      # the serialized params hash from Sidekiq contains a Op::UploadedFile hash.
+
+      # the following code is basically what happens in a controller.
+      # this is a bug in Rails, it doesn't work without requiring as/hash/ina
+      # params = ActiveSupport::HashWithIndifferentAccess.new_from_hash_copying_default(params) # TODO: this might make it ultra-slow as Reform converts it back to strings.
+      params = @params.with_indifferent_access
+      @params = deserializable(params)
+      run
+    end
+
+  private
+    def deserializable(params)
+      params # this is where we convert file uloads into Trailblazer::UploadedFile, etc. soon.
+    end
+
+
+    # Overrides ::serializable and #deserializable and handles file properties from the Contract schema.
+    module FileMarshaller
+      # NOTE: this is WIP and the implementation will be more understandable and performant soon.
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+
+    private
+      module ClassMethods
+        def file_marshaller_representer
+          @file_marshaller_representer ||= contract_class.schema(include: [Representable::Hash]).apply do |dfn|
+            dfn.merge!(
+              getter: lambda { |*| self[dfn.name.to_sym] },
+              setter: lambda { |fragment, *| self[dfn.name.to_s] = fragment }
+            ) # FIXME: allow both sym and str.
+
+            dfn.merge!(class: Hash) and next if dfn[:form] or dfn[:twin] # nested properties need a class for deserialization.
+            next unless dfn[:file]
+
+            # TODO: where do we set /tmp/uploads?
+            dfn.merge!(
+              serialize: lambda { |file, *| Trailblazer::Operation::UploadedFile.new(file, tmp_dir: "/tmp/uploads").to_hash },
+              deserialize: lambda { |object, hash, *| Trailblazer::Operation::UploadedFile.from_hash(hash) },
+              class: Hash
+            )
+          end
+        end
+
+        def serializable(params)
+          file_marshaller_representer.new(params).to_hash
+        end
+      end
+
+      # todo: do with_indifferent_access in #deserialize and call super here.
+      def deserializable(hash)
+        # self.class.file_marshaller_representer.new({}).extend(Representable::Debug).from_hash(hash)
+        self.class.file_marshaller_representer.new({}.with_indifferent_access).from_hash(hash)
+      end
+    end
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/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/test/dummy/app/assets/stylesheets/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/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/test/dummy/config/application.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "tb_heavy_control"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!