brace_comb 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aaeb1d4b8c9364abcf4faa7f520def42a3181a69
+  data.tar.gz: 05e4fd1cee33718bdf03e001263d447a23ac2b58
+SHA512:
+  metadata.gz: 414d1aa676d6b862f2391be9a822515bae2d3627d6c2c6e8e71724da5534526729009929d0979d8ca66190f1563743b6e1dfc864f879e2a51794e756d3a1342f
+  data.tar.gz: e48fd0c6d8320910b9ea27efcf09603258b46d2eaadd421ed786bcc5dd1d090618e561140002d7dc39a3195695a962b93505945f2324402787afa5bb3f3370a9

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ankitagupta12391@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/README.md

@@ -0,0 +1,96 @@
+# BraceComb
+
+Brace Comb is a small bit of wax built between two combs or frames to fasten them together. Brace comb is also built between a comb and adjacent wood, or between two wooden parts such as top bars.
+
+Allows setting dependency logic between entities, and declaring resolution methods and callbacks to resolve dependencies.
+
+## Background
+
+In workflow management systems, there is often a need to define that certain tasks should only begin when another task(s) is complete.
+
+Instead of having each workflow system define database entities to denote dependency relationships between tasks/dependents, this gem provides features that can create both the dependency and dependent model. These entity names are configurable based on the project needs. 
+
+In addition, it accepts methods/procs to define the logic for dependency resolution via resolution callbacks. In the same vein as active record callbacks, dependency resolution callbacks can define actions that should be executed before a dependency is resolved and after a dependency is resolved. If any before callbacks fail, then dependency resolution will also fail.
+
+## Installation
+
+1. Add JobDependencies to your `Gemfile`.
+
+    `gem 'brace_comb'`
+
+2. Create an initializer for `brace_comb` 
+
+    a. `bundle exec rails generate brace_comb:initializer`
+    
+    b. Modify the name of dependency and dependent tables in the initializer `config/initializers/brace_comb.rb`
+    
+    c. Run `bundle exec rails generate brace_comb:migration` to create the migration
+    
+    d. Create the dependency tables and associations using `bundle exec rake db:migrate`
+    
+    e. Generate the basic dependency model by running:
+       ```bundle exec rails generate brace_comb:model ''```
+
+## Usage
+  
+1. Declare a dependency type by adding in the following to the dependency class:
+   ```
+     include BraceComb::Helper
+     enum type: { shopping: 0 }
+   ```
+2. Declare a dependency by typing in the following in any ActiveRecord class:
+
+   a. Using a method name in the resolver
+   ```
+     declare_dependency type: :shopping,
+                        resolver: :shopping_complete
+                        before_resolved: [:completed_status?],
+                        after_resolved: [:complete_job]
+   ```
+   
+   or 
+   
+   b. Using a proc in the resolver
+   
+   ```
+     declare_dependency type: :shopping,
+                        resolver: ->(data) { data.condition },
+                        before_resolved: [:completed_status?],
+                        after_resolved: [:complete_job]
+   ```
+3. Create dependencies between the dependent class by using the following helper in any instance method of a model class:
+
+   - When an exception needs to be raised:
+   `initialize_dependency! from: job1, to: job2, type: 'shopping'`
+
+   or
+   - When a boolean needs to be returned:
+   `initialize_dependency from: job1, to: job2, type: 'shopping'`
+
+5. Resolve dependencies from any active record model by using:
+   
+   - When an exception needs to be raised:
+   ```
+     dependency.resolve!(identifier: 123, status: :resolved)
+   ```
+   
+   or
+   - When a boolean needs to be returned: 
+   
+   ```
+     dependency.resolve(identifier: 123, status: :resolved)
+   ```
+   Any arguments passed to `resolve!` methods will be directly sent to the resolver. So arguments should be sent based on the resolver definition
+
+## Under consideration
+   - Allowing dependency declaration to accept multiple resolvers, and allowing resolve to accept the name of the resolver. This could possibly by done in `resolve` method itself instead of `declare_dependency`
+   - Automatically including the concern for `resolve` inside the dependency class
+   - Combining the installation steps into 1-2 steps
+   - And more...
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/honestbee/brace_comb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'job_dependencies'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/brace_comb.rb

@@ -0,0 +1,34 @@
+require 'dry-configurable'
+
+require 'brace_comb/version'
+require 'brace_comb/config'
+require 'brace_comb/dependency_model'
+require 'brace_comb/dependency_helper'
+
+module BraceComb
+  class << self
+    # return config
+    def config
+      Config.config
+    end
+
+    # Provides a block to override default config
+    def setup(&block)
+      Config.setup(&block)
+    end
+
+    def dependency_model
+      config.dependency_table_name.singularize.camelize
+    end
+
+    def dependent_model
+      config.dependent_table_name.singularize.camelize
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  include BraceComb::Model
+end
+
+

data/lib/brace_comb/config.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+module BraceComb
+  # configurator for setting up all the configurable settings for job dependency
+  class Config
+    extend Dry::Configurable
+      # defines the table name between which dependencies are created
+    setting :dependent_table_name, 'job'
+    setting :dependency_table_name, 'job_dependency'
+
+    class << self
+      def setup
+        configure do |config|
+          yield(config)
+        end
+      end
+    end
+  end
+end

data/lib/brace_comb/dependency_helper.rb

@@ -0,0 +1,77 @@
+module BraceComb
+  module Helper
+    module ClassMethods
+      # declare_dependency
+      #   type: :shopping
+      #   resolver: :shopping_completed
+      #   before_resolved: [:completed_status?]
+      #   after_resolved: :complete_job, Proc.new {}
+      # Options:
+      # resolver: Methods or procs that can mark the dependency as resolved
+      # before_resolved: Checks that can be performed before a dependency is resolved.
+      # If any of these return false then the dependency resolution will result in a false
+      # or exception.
+      # after_resolved: if the dependency resolution succeeds, each of these methods will be
+      # executed one by one. All the subsequent after_resolved hooks will not be executed if any
+      # of the predecessor after_resolved hook throws an exception. However, this will not make
+      # a difference to the resolution status of the dependency itself
+      def declare_dependency(options = {})
+        dependency_mapping = dependency_mapping_value
+        dependency_mapping[options[:type]] = options.slice(
+          :resolver,
+          :before_resolved,
+          :after_resolved
+        )
+        set_dependency_mapping(dependency_mapping)
+      end
+
+      def dependency_mapping_value
+        klass = dependency_model
+        dependency_mapping = klass.instance_variable_get(:@dependency_mapping)
+        value = dependency_mapping || {}
+        value.tap do |dependency_mapping_value|
+          klass.instance_variable_set(:@dependency_mapping, dependency_mapping_value)
+        end
+      end
+
+      def set_dependency_mapping(value)
+        dependency_model.instance_variable_set(:@dependency_mapping, value)
+      end
+
+      def dependency_model
+        ::BraceComb.dependency_model.constantize
+      end
+
+      # private_class_method :dependency_mapping_value, :set_dependency_mapping
+    end
+
+    module InstanceMethods
+      # initialize_dependency from: job1, to: job2, type: 'shopping'
+      def initialize_dependency(from: nil, to: nil, dependency_type: nil)
+        dependency_model.create(
+          source_id: from,
+          destination_id: to,
+          dependency_type: dependency_type
+        )
+      end
+
+      # initialize_dependency from: job1, to: job2, type: 'shopping'
+      def initialize_dependency!(from: nil, to: nil, dependency_type: nil)
+        dependency_model.create!(
+          source_id: from,
+          destination_id: to,
+          dependency_type: dependency_type
+        )
+      end
+
+      def dependency_model
+        ::BraceComb.dependency_model.constantize
+      end
+    end
+
+    def self.included(base)
+      base.send :include, InstanceMethods
+      base.send :extend, ClassMethods
+    end
+  end
+end

data/lib/brace_comb/dependency_model.rb

@@ -0,0 +1,66 @@
+require 'brace_comb/exceptions/callback_failure'
+
+module BraceComb
+  module Model
+    module InstanceMethods
+      # throws an exception if before callbacks return false
+      # throws an exception if before, after callbacks or resolver raises an exception
+      # rolls back the transaction if before callbacks return false or if any exception is raised
+      def resolve!(args = nil)
+        dependency_mapping = self.class.
+          instance_variable_get(:@dependency_mapping)[self.dependency_type.to_sym]
+        ActiveRecord::Base.transaction do
+          execute_before_callbacks(dependency_mapping[:before_resolved])
+          execute_resolver(dependency_mapping[:resolver], args)
+          execute_after_callbacks(dependency_mapping[:after_resolved])
+        end
+      end
+
+      # returns false if before callbacks return false
+      # throws an exception if before, after callbacks or resolver raises an exception
+      # rolls back the transaction if before callbacks return false or if any exception is raised
+      def resolve(args = nil)
+        resolve!(args)
+        true
+      rescue BraceComb::Exceptions::CallbackFailure
+        false
+      end
+
+      def execute_after_callbacks(after_callbacks)
+        after_callbacks.each do |after_callback|
+          execute_callback(after_callback)
+        end
+      end
+
+      # Resolver can be a proc or method
+      def execute_resolver(resolver, args)
+        return resolver.call(self) if resolver.respond_to?(:call)
+        if method(resolver).arity.zero?
+          __send__(resolver)
+        else
+          __send__(resolver, args)
+        end
+      end
+
+      def execute_before_callbacks(before_callbacks)
+        before_callbacks.each do |before_callback|
+          result = execute_callback(before_callback)
+          raise BraceComb::Exceptions::CallbackFailure.new unless result
+        end
+      end
+
+      # Callbacks can be procs or methods
+      def execute_callback(callback)
+        if callback.respond_to?(:call)
+          callback.call(self)
+        else
+          __send__(callback)
+        end
+      end
+    end
+
+    def self.included(base)
+      base.send :include, InstanceMethods
+    end
+  end
+end

data/lib/brace_comb/exceptions/callback_failure.rb

@@ -0,0 +1,9 @@
+module BraceComb
+  module Exceptions
+    class CallbackFailure < StandardError
+      def initialize(msg = 'Callback failed')
+        super
+      end
+    end
+  end
+end

data/lib/brace_comb/version.rb

@@ -0,0 +1,3 @@
+module BraceComb
+  VERSION = '0.0.2'
+end

data/lib/generators/brace_comb/generator.rb

@@ -0,0 +1,14 @@
+require 'brace_comb'
+module BraceComb
+  class Generator < Rails::Generators::Base
+    private
+
+    def dependent_table_name
+      ::BraceComb.config.dependent_table_name.pluralize.downcase
+    end
+
+    def dependency_table_name
+      ::BraceComb.config.dependency_table_name.pluralize.downcase
+    end
+  end
+end

data/lib/generators/brace_comb/initializer_generator.rb

@@ -0,0 +1,16 @@
+require 'generators/brace_comb/generator'
+require 'rails/generators'
+module BraceComb
+  # creates job depedency initializer
+  class InitializerGenerator < Generator
+    def create_initializer
+      create_file(
+        'config/initializers/brace_comb.rb',
+        "BraceComb.setup do |config|\n"\
+          " config.dependent_table_name = '#{dependent_table_name}'\n"\
+          " config.dependency_table_name = '#{dependency_table_name}'\n"\
+          "end"
+      )
+    end
+  end
+end

data/lib/generators/brace_comb/migration_generator.rb

@@ -0,0 +1,47 @@
+require 'generators/brace_comb/generator'
+require 'rails/generators'
+require 'rails/generators/active_record'
+module BraceComb
+  # Installs job dependencies migrations
+  class MigrationGenerator < Generator
+    include ::Rails::Generators::Migration
+    source_root File.expand_path('../templates', __FILE__)
+
+    def create_migration_file
+      add_migrations(dependent_table_name, 'create_dependent')
+      add_migrations(dependency_table_name, 'create_dependencies')
+      add_migrations(nil, 'add_associations')
+    end
+
+    private
+
+    def add_migrations(table_name, template)
+      migration_dir = File.expand_path("db/migrate")
+      migration_name = table_name || template
+      if migration_exists?(migration_dir, migration_name)
+        ::Kernel.warn "Migration already exists: #{migration_name}"
+      else
+        migration_template(
+          "#{template}.rb.erb",
+          "db/migrate/#{migration_name.pluralize}.rb",
+          migration_version: migration_version
+        )
+      end
+    end
+
+    def migration_exists?(migration_dir, table_name)
+      [table_name.singularize, table_name.pluralize].any? do |table|
+        self.class.migration_exists?(migration_dir, "create_#{table}")
+      end
+    end
+
+    def self.next_migration_number(dirname)
+      ::ActiveRecord::Generators::Base.next_migration_number(dirname)
+    end
+
+    def migration_version
+      major = ActiveRecord::VERSION::MAJOR
+      "[#{major}.#{ActiveRecord::VERSION::MINOR}]" if major >= 5
+    end
+  end
+end

data/lib/generators/brace_comb/model_generator.rb

@@ -0,0 +1,47 @@
+require 'rails/generators/active_record'
+require 'brace_comb'
+module BraceComb
+  # creates job depedency initializer
+  class ModelGenerator < ActiveRecord::Generators::Base
+    def generate_model
+      invoke 'active_record:model',
+             [dependency_model],
+             migration: false unless model_exists? && behavior == :invoke
+    end
+
+    def inject_model_content
+      content = model_contents
+
+      class_path = if namespaced?
+                     class_name.to_s.split('::')
+                   else
+                     [class_name]
+                   end
+
+      indent_depth = class_path.size - 1
+      content = content.split('\n').map { |line| '  ' * indent_depth + line } .join('\n') << '\n'
+
+      inject_into_class(model_path, class_path.last, content) if model_exists?
+    end
+
+    private
+
+    def dependency_model
+      ::BraceComb.dependency_model.to_s.underscore
+    end
+
+    def model_exists?()
+      File.exist?(File.join(destination_root, model_path))
+    end
+
+    def model_path
+      @model_path ||= File.join('app', 'models', "#{dependency_model}.rb")
+    end
+
+    def model_contents
+      <<-CONTENT
+        enum status: { pending: 0, resolved: 2 }
+      CONTENT
+    end
+  end
+end

metadata

@@ -0,0 +1,205 @@
+--- !ruby/object:Gem::Specification
+name: brace_comb
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Ankita Gupta
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+- !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: with_model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Allows setting of dependenices between jobs and setting rules for dependency
+  resolution
+email:
+- ankita.gupta@honestbee.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- README.md
+- bin/console
+- bin/setup
+- lib/brace_comb.rb
+- lib/brace_comb/config.rb
+- lib/brace_comb/dependency_helper.rb
+- lib/brace_comb/dependency_model.rb
+- lib/brace_comb/exceptions/callback_failure.rb
+- lib/brace_comb/version.rb
+- lib/generators/brace_comb/generator.rb
+- lib/generators/brace_comb/initializer_generator.rb
+- lib/generators/brace_comb/migration_generator.rb
+- lib/generators/brace_comb/model_generator.rb
+homepage: https://github.com/honestbee/brace_comb
+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.7
+signing_key: 
+specification_version: 4
+summary: Allows creation of job dependencies
+test_files: []