brace_comb 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aaeb1d4b8c9364abcf4faa7f520def42a3181a69
-  data.tar.gz: 05e4fd1cee33718bdf03e001263d447a23ac2b58
+  metadata.gz: 8fe368a2abc127eb6eabb97dd00821f440d0e715
+  data.tar.gz: 31c9abbd499456fa9fa5a4d0c734166ead74d4cc
 SHA512:
-  metadata.gz: 414d1aa676d6b862f2391be9a822515bae2d3627d6c2c6e8e71724da5534526729009929d0979d8ca66190f1563743b6e1dfc864f879e2a51794e756d3a1342f
-  data.tar.gz: e48fd0c6d8320910b9ea27efcf09603258b46d2eaadd421ed786bcc5dd1d090618e561140002d7dc39a3195695a962b93505945f2324402787afa5bb3f3370a9
+  metadata.gz: 56f9d83c4244ba7d54317b750c0f25efb4615344cd4e855bd9fb461b426b64d78619d6ae799151bd32a7ea83720be202fd0a593e17771c7615ac9ec265944661
+  data.tar.gz: 8c3c00d2aa57ed9308a9d73f77da66f3f9234a6861ed9a172ca98504cf197b01390e8e0a8f642f8359e60e063f0319938c83d9bf0cfafca281c3f1fef58d0ead

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+#Ignore editor configs
+.idea/
+.vscode/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in brace_comb.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ankita Gupta
+
+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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/brace_comb.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'brace_comb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'brace_comb'
+  spec.version       = BraceComb::VERSION
+  spec.authors       = ['Ankita Gupta']
+  spec.email         = ['ankita.gupta@honestbee.com']
+
+  spec.summary       = 'Allows creation of job dependencies'
+  spec.description   = 'Allows setting of dependenices between jobs and setting rules for dependency resolution'
+  spec.homepage      = 'https://github.com/honestbee/brace_comb'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord', ['>= 4.0', '< 5.2']
+  spec.add_dependency 'dry-configurable', '~> 0.6'
+
+  spec.add_development_dependency 'activesupport', '>= 4.2.5'
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'generator_spec', '~> 0.9.3'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec-rails', '~> 3.5'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'with_model', '~> 1.2'
+end

data/lib/brace_comb/version.rb

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

data/lib/generators/brace_comb/model_generator.rb

@@ -11,16 +11,9 @@ module BraceComb
 
     def inject_model_content
       content = model_contents
-
-      class_path = if namespaced?
-                     class_name.to_s.split('::')
-                   else
-                     [class_name]
-                   end
-
+      class_path = [dependency_model.camelize]
       indent_depth = class_path.size - 1
-      content = content.split('\n').map { |line| '  ' * indent_depth + line } .join('\n') << '\n'
-
+      content = content.split('\n').map { |line| '  ' * indent_depth + line } .join('\n')
       inject_into_class(model_path, class_path.last, content) if model_exists?
     end
 
@@ -40,8 +33,8 @@ module BraceComb
 
     def model_contents
       <<-CONTENT
-        enum status: { pending: 0, resolved: 2 }
+        enum status: { pending: 0, resolved: 1 }
       CONTENT
     end
   end
-end
+end

data/lib/generators/brace_comb/templates/add_associations.rb.erb

@@ -0,0 +1,7 @@
+# This migration adds associations between the dependency and dependent
+class AddAssociations < ActiveRecord::Migration<%= migration_version %>
+  def change
+    add_foreign_key :<%= dependency_table_name%>, :<%= dependent_table_name %>, column: :source_id, dependent: :delete
+    add_foreign_key :<%= dependency_table_name%>, :<%= dependent_table_name %>, column: :destination_id, dependent: :delete
+  end
+end

data/lib/generators/brace_comb/templates/create_dependencies.rb.erb

@@ -0,0 +1,13 @@
+# This migration creates the `dependencies` table
+class Create<%= dependency_table_name.camelize %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :<%= dependency_table_name %> do |t|
+      t.integer :dependency_type, null: false
+      t.integer :status
+      t.integer :source_id, null: false
+      t.integer :destination_id, null: false
+      t.timestamps null: false
+    end
+    add_index :<%= dependency_table_name %>, %i(source_id destination_id)
+  end
+end

data/lib/generators/brace_comb/templates/create_dependent.rb.erb

@@ -0,0 +1,8 @@
+# This migration creates the dependent table
+class Create<%= dependent_table_name.camelize %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :<%= dependent_table_name %> do |t|
+      t.timestamps null: false
+    end
+  end
+end

data/spec/brace_comb/dependency_helper_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+require 'brace_comb/dependency_helper'
+
+describe BraceComb::Helper do
+  dependency_class = ::BraceComb.dependency_model
+  dependent_class = ::BraceComb.dependent_model
+  with_model dependency_class do
+    table do |t|
+      t.integer :dependency_type
+      t.integer :status
+      t.integer :source_id
+      t.integer :destination_id
+      t.timestamps null: false
+    end
+  end
+
+  with_model dependent_class do
+    table do |t|
+      t.timestamps null: false
+    end
+  end
+  context 'dependency_helper' do
+    let(:source) { dependent_class.constantize.create }
+    let(:destination) { dependent_class.constantize.create }
+
+    context '#declare_dependency' do
+      before do
+        dependency_class.constantize.class_eval do
+          include BraceComb::Helper
+
+          declare_dependency type: :shopping,
+                             resolver: :shopping_complete,
+                             before_resolved: [:completed_status?],
+                             after_resolved: [:complete_job]
+        end
+      end
+      it 'can declare dependency' do
+        dependency_mapping = JobDependency.instance_variable_get(:@dependency_mapping)
+        expect(dependency_mapping).to match(
+          shopping: {
+            resolver: :shopping_complete,
+            before_resolved: [:completed_status?],
+            after_resolved: [:complete_job]
+          }
+        )
+      end
+    end
+
+    context '#initialize_dependency' do
+      before do
+        dependency_class.constantize.class_eval do
+          include BraceComb::Helper
+          enum dependency_type: {shopping: 0}
+
+          validates :source_id, presence: true
+        end
+      end
+
+      let(:new_dependency) do
+        dependency_class.constantize.new.initialize_dependency(
+          from: source.id,
+          to: destination.id,
+          dependency_type: :shopping
+        )
+      end
+
+      it 'creates a dependency' do
+        expect(new_dependency.present?).to eq(true)
+        expect(new_dependency.source_id).to eq(source.id)
+        expect(new_dependency.destination_id).to eq(destination.id)
+        expect(new_dependency.dependency_type).to eq('shopping')
+      end
+
+      it 'returns false if a dependency cannot be created' do
+        dependency = dependency_class.constantize.new.initialize_dependency
+        expect(dependency.valid?).to be false
+      end
+    end
+
+    context '#initialize_dependency!' do
+      before do
+        dependency_class.constantize.class_eval do
+          include BraceComb::Helper
+
+          enum dependency_type: {shopping: 0}
+          validates :source_id, presence: true
+        end
+      end
+
+      let(:new_dependency) do
+        dependency_class.constantize.new.initialize_dependency!(
+          from: source.id,
+          to: destination.id,
+          dependency_type: :shopping
+        )
+      end
+
+      it 'creates a dependency' do
+        expect(new_dependency.present?).to eq(true)
+        expect(new_dependency.source_id).to eq(source.id)
+        expect(new_dependency.destination_id).to eq(destination.id)
+        expect(new_dependency.dependency_type).to eq('shopping')
+      end
+
+      it 'raises error if a dependency cannot be created' do
+        expect { dependency_class.constantize.new.initialize_dependency! }.to raise_error
+      end
+    end
+  end
+end

data/spec/brace_comb/dependency_model_spec.rb

@@ -0,0 +1,156 @@
+require 'spec_helper'
+require 'brace_comb/dependency_helper'
+require 'brace_comb/dependency_model'
+require 'pry'
+describe BraceComb::Model do
+  dependency_class = ::BraceComb.dependency_model
+  dependent_class = ::BraceComb.dependent_model
+  with_model dependency_class do
+    table do |t|
+      t.integer :dependency_type
+      t.integer :status
+      t.integer :source_id
+      t.integer :destination_id
+      t.timestamps null: false
+    end
+  end
+
+  with_model dependent_class do
+    table do |t|
+      t.timestamps null: false
+    end
+  end
+
+  before do
+    dependency_class.constantize.class_eval do
+      include BraceComb::Helper
+
+      enum dependency_type: { shopping: 0 }
+      enum status: { pending: 0, resolved: 1 }
+
+      declare_dependency type: :shopping,
+                         resolver: :mark_as_complete,
+                         before_resolved: [:before_resolve1?, :before_resolve2?],
+                         after_resolved: [:complete_job]
+    end
+  end
+
+  let(:source) { dependent_class.constantize.create }
+  let(:destination) { dependent_class.constantize.create }
+  let(:dependency) do
+    dependency_class.constantize.new.initialize_dependency!(
+      from: source.id,
+      to: destination.id,
+      dependency_type: :shopping
+    )
+  end
+
+  context '#resolve' do
+    context 'resolve using a function' do
+      context 'before resolve callbacks not satisfied' do
+        before do
+          class JobDependency
+            def before_resolve1?
+              true
+            end
+
+            def before_resolve2?
+              false
+            end
+
+            def mark_as_complete
+              resolved!
+            end
+          end
+        end
+
+        it 'does not resolve dependency if all before resolve hooks are not satisfied' do
+          result = dependency.resolve
+          expect(dependency).not_to be_resolved
+          expect(result).to be false
+        end
+      end
+
+      context 'before resolve callbacks are satisfied' do
+        before do
+          class JobDependency
+            def before_resolve1?
+              true
+            end
+
+            def before_resolve2?
+              true
+            end
+
+            def mark_as_complete
+              resolved!
+            end
+
+            def complete_job
+              true
+            end
+          end
+        end
+
+        it 'resolves dependency if no exceptions are raised' do
+          result = dependency.resolve
+          expect(dependency).not_to receive(:complete_job).and_call_original
+          expect(dependency).to be_resolved
+          expect(result).to be true
+        end
+      end
+    end
+
+    context 'resolve using a proc' do
+      before do
+        dependency_class.constantize.class_eval do
+          declare_dependency type: :shopping,
+                             resolver: ->(data) { data.resolved! },
+                             before_resolved: [->(_) { true }, :before_resolve?],
+                             after_resolved: [:complete_job]
+        end
+
+        class JobDependency
+          def before_resolve?
+            true
+          end
+
+          def complete_job
+            true
+          end
+        end
+      end
+
+      it 'resolves dependency if all before resolve hooks are satisfied' do
+        result = dependency.resolve
+        expect(dependency).not_to receive(:complete_job).and_call_original
+        expect(dependency).to be_resolved
+        expect(result).to be true
+      end
+    end
+  end
+
+  context 'resolve' do
+    context 'before resolve callbacks not satisfied' do
+      before do
+        class JobDependency
+          def before_resolve1?
+            true
+          end
+
+          def before_resolve2?
+            false
+          end
+
+          def mark_as_complete
+            resolved!
+          end
+        end
+      end
+
+      it 'does not resolve dependency if all before resolve hooks are not satisfied' do
+        expect { dependency.resolve! }.to raise_error(BraceComb::Exceptions::CallbackFailure)
+      end
+    end
+  end
+end

data/spec/factories/dependency_table.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+class DependentTable
+  def moo
+    dependent_class = ::BraceComb.dependent_model
+    with_model dependent_class do
+      table do |t|
+        t.timestamps null: false
+      end
+    end
+  end
+end

data/spec/generators/brace_comb/initializer_generator_spec.rb

@@ -0,0 +1,23 @@
+require 'generator_spec/test_case'
+require 'generators/brace_comb/initializer_generator'
+
+describe BraceComb::InitializerGenerator, type: :generator do
+  include GeneratorSpec::TestCase
+  destination File.expand_path('../tmp', __FILE__)
+
+  after(:all) { prepare_destination }
+
+  context '#create_initializer' do
+    before(:all) do
+      prepare_destination
+      run_generator
+    end
+
+    it 'creates brace comb initializer' do
+      assert_file 'config/initializers/brace_comb.rb', "BraceComb.setup do |config|\n"\
+        " config.dependent_table_name = 'jobs'\n"\
+        " config.dependency_table_name = 'job_dependencies'\n"\
+        "end"
+    end
+  end
+end

data/spec/generators/brace_comb/migration_generator_spec.rb

@@ -0,0 +1,53 @@
+require 'generator_spec/test_case'
+require 'generators/brace_comb/migration_generator'
+
+describe BraceComb::MigrationGenerator, type: :generator do
+  include GeneratorSpec::TestCase
+  destination File.expand_path('../tmp', __FILE__)
+
+  after(:all) { prepare_destination }
+
+  context '#create_migration_file' do
+    before(:all) do
+      prepare_destination
+      run_generator
+    end
+
+    it 'generates migrations' do
+      parent_class =  lambda {
+        old_version = 'ActiveRecord::Migration'
+        new_version = ActiveRecord::VERSION
+        if new_version::MAJOR >= 5
+          format("%s[%d.%d]", old_version, new_version::MAJOR, new_version::MINOR)
+        else
+          old_version
+        end
+      }.call
+      expect(destination_root).to have_structure {
+        directory 'db' do
+          directory 'migrate' do
+            migration 'jobs' do
+              contains('class CreateJobs < ' + parent_class)
+              contains('create_table :jobs do |t|')
+              contains('t.timestamps null: false')
+            end
+            migration 'job_dependencies' do
+              contains('create_table :job_dependencies do |t|')
+              contains('class CreateJobDependencies < ' + parent_class)
+              contains('t.integer :dependency_type, null: false')
+              contains('t.integer :status')
+              contains('t.integer :source_id, null: false')
+              contains('t.integer :destination_id, null: false')
+              contains('t.timestamps null: false')
+            end
+            migration 'add_associations' do
+              contains('class AddAssociations < ' + parent_class)
+              contains('add_foreign_key :job_dependencies, :jobs, column: :source_id, dependent: :delete')
+              contains('add_foreign_key :job_dependencies, :jobs, column: :destination_id, dependent: :delete')
+            end
+          end
+        end
+      }
+    end
+  end
+end

data/spec/generators/brace_comb/model_generator_spec.rb

@@ -0,0 +1,29 @@
+require 'generator_spec/test_case'
+require 'generators/brace_comb/model_generator'
+
+describe BraceComb::ModelGenerator, type: :generator do
+  include GeneratorSpec::TestCase
+  destination File.expand_path('../tmp', __FILE__)
+
+  after(:all) { prepare_destination }
+
+  context '#generate_model' do
+    before(:all) do
+      prepare_destination
+      run_generator %w('')
+    end
+
+    it 'creates a model' do
+      expect(destination_root).to have_structure {
+        directory 'app' do
+          directory 'models' do
+            file 'job_dependency.rb' do
+              contains('class JobDependency < ApplicationRecord')
+              contains('enum status: { pending: 0, resolved: 1 }')
+            end
+          end
+        end
+      }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+require 'active_record'
+require 'active_support'
+require 'brace_comb'
+require 'with_model'
+
+RSpec.configure do |config|
+  config.extend WithModel
+end
+
+is_jruby = RUBY_PLATFORM == 'java'
+adapter = is_jruby ? 'jdbcsqlite3' : 'sqlite3'
+
+# WithModel requires ActiveRecord::Base.connection to be established.
+# If ActiveRecord already has a connection, as in a Rails app, this is unnecessary.
+ActiveRecord::Base.establish_connection(adapter: adapter, database: ':memory:')
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brace_comb
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ankita Gupta
@@ -164,10 +164,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
 - CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
 - README.md
+- Rakefile
 - bin/console
 - bin/setup
+- brace_comb.gemspec
 - lib/brace_comb.rb
 - lib/brace_comb/config.rb
 - lib/brace_comb/dependency_helper.rb
@@ -178,6 +184,16 @@ files:
 - lib/generators/brace_comb/initializer_generator.rb
 - lib/generators/brace_comb/migration_generator.rb
 - lib/generators/brace_comb/model_generator.rb
+- lib/generators/brace_comb/templates/add_associations.rb.erb
+- lib/generators/brace_comb/templates/create_dependencies.rb.erb
+- lib/generators/brace_comb/templates/create_dependent.rb.erb
+- spec/brace_comb/dependency_helper_spec.rb
+- spec/brace_comb/dependency_model_spec.rb
+- spec/factories/dependency_table.rb
+- spec/generators/brace_comb/initializer_generator_spec.rb
+- spec/generators/brace_comb/migration_generator_spec.rb
+- spec/generators/brace_comb/model_generator_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/honestbee/brace_comb
 licenses:
 - MIT