laminar-rails 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 22c13b8e518c5dabd3d8633f1ae52a396e00a2f4
+  data.tar.gz: 9ae3157f8b24d20c6c62a526cd953d6d0a6f58da
+SHA512:
+  metadata.gz: ab3d1a0185f50a898787031d75d05ddbcbb41ac385e68c355755637482af18a3d91f583d6cd774bbf7ead650d30b6c673651e8a57009c73f1bae529836552234
+  data.tar.gz: 3724c3be2a69d2681a97b7acf2788cbfa9bb853fb4f03a4d8df05173ada4211c47ca0732fdbe298067dc2c68015be413e8f30cfd1e4abd783bb316c6920b7934

data/.gitignore

@@ -0,0 +1,13 @@
+*.gem
+Gemfile.lock
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--order random

data/.travis.yml

@@ -0,0 +1,21 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+branches:
+  only:
+    - master
+gemfile:
+  - gemfiles/rails42.gemfile
+  - gemfiles/rails50.gemfile
+  - gemfiles/rails51.gemfile
+  - gemfiles/rails52.gemfile
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+before_install: gem install bundler -v 1.16.5
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Change Log
+
+
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

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 robertl@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/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 laminar-rails.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 HubertVonHerbert
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Robert Lockerd
+
+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,91 @@
+# Laminar on Rails
+
+Adds Rails support to the Laminar workflow gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'laminar-rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install laminar-rails
+
+## Usage
+
+Laminar-Rails adds a couple of generators to facilitate the creation of
+new Laminar particles and flows.
+
+```
+$ rails generate laminar:particle foo
+```
+
+The generator adds a file ``app/flows/foo.rb``:
+
+```ruby
+class Foo
+  include Laminar::Particle
+
+  def call
+    # TODO
+  end
+end
+```
+
+The generator also adds a matching ``spec/flows/foo_spec.rb``.
+
+There is also a flow generator:
+
+```
+$ rails generate laminar:flow foo
+```
+
+that creates a flow template:
+
+```ruby
+class Foo
+  include Laminar::Flow
+
+  # flow do
+    # step :step1
+    # step :step2
+  # end
+end
+```
+
+You can specify particle names on the generator command line.
+```
+$ rails generate laminar:flow foo something something_else
+```
+
+will create a new flow pre-populated with steps:
+
+```ruby
+class Foo
+  include Laminar::Flow
+
+  flow do
+    step :something
+    step :something_else
+  end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/laminar-rails. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Laminar::Rails project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/laminar-rails/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "laminar/rails"
+
+# 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/gemfiles/rails42.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "rails", "~> 4.2"

data/gemfiles/rails50.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "rails", "~> 5.0"

data/gemfiles/rails51.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "rails", "~> 5.1"

data/gemfiles/rails52.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "rails", "~> 5.2"

data/laminar-rails.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "laminar/rails/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "laminar-rails"
+  spec.version       = Laminar::Rails::VERSION
+  spec.authors       = ["Robert Lockerd"]
+  spec.email         = ["rmlockerd@gmail.com"]
+
+  spec.summary       = %q{Laminar gem support for Rails applications.}
+  spec.homepage      = "https://github.com/rmlockerd/laminar-rails"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rails', ">= 4.2", "< 5.3"
+  spec.add_dependency 'laminar', "~> 0.3"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "aruba", "~> 0.14"
+  spec.add_development_dependency 'simplecov', '~> 0.16'
+end

data/lib/generators/common_generator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Generator for new particles.
+class CommonGenerator < Rails::Generators::NamedBase
+  class_option :spec, type: :boolean, default: true
+
+  def generate
+    self.class.source_root(File.expand_path('templates', __dir__))
+
+    template "#{self.class.generator_name}.erb",
+             File.join('app/flows', class_path, "#{file_name}.rb")
+
+    return unless options[:spec]
+
+    template 'spec.erb',
+             File.join('spec/flows', class_path, "#{file_name}_spec.rb")
+  end
+end

data/lib/generators/laminar/flow/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate laminar:flow Thing
+
+    This will create:
+        app/flows/thing.rb
+        spec/flows/thing_spec.rb

data/lib/generators/laminar/flow/flow_generator.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'generators/common_generator'
+
+module Laminar
+  # Generator for new Flows
+  class FlowGenerator < CommonGenerator
+    argument :particles, type: :array, default: [], banner: 'particle1 particle2 ...'
+  end
+end

data/lib/generators/laminar/particle/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate laminar:particle Thing
+
+    This will create:
+        app/flows/thing.rb
+        spec/flows/thing_spec.rb

data/lib/generators/laminar/particle/particle_generator.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'generators/common_generator'
+
+module Laminar
+  class ParticleGenerator < CommonGenerator
+  end
+end

data/lib/generators/templates/flow.erb

@@ -0,0 +1,17 @@
+class <%= class_name %>
+  include Laminar::Flow
+
+  <%- if particles.any? -%>
+    flow do
+      <%- particles.each do |p| -%>
+        step :<%= p %>
+      <%- end -%>
+    end
+  <%- else -%>
+    #   flow do
+    #     step :first
+    #     step :then_me
+    #     step :last_step
+    #   end
+  <%- end -%>
+end

data/lib/generators/templates/particle.erb

@@ -0,0 +1,7 @@
+class <%= class_name %>
+  include Laminar::Particle
+
+  def call
+    # TODO
+  end
+end

data/lib/generators/templates/spec.erb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+RSpec.describe <%= class_name %>, type: :particle do
+  describe '.call' do
+    pending "add some examples to (or delete) #{__FILE__}"
+  end
+end

data/lib/laminar/rails/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Laminar
+  module Rails
+    VERSION = '0.2.0'
+  end
+end

data/lib/laminar/rails.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'laminar'
+require 'laminar/transacticle'

data/lib/laminar/transacticle.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'active_record'
+
+module Laminar
+  # Extends Laminar::Particle to include methods to wrap calls in
+  # ActiveRecord transactions.
+  module Transacticle
+
+    def self.included(klass)
+      klass.class_eval do
+        include Laminar::Particle
+        extend ClassMethods
+      end
+    end
+
+    # Laminar::Particle class methods and attributes.
+    module ClassMethods
+      def call_with_txn(context = {})
+        self.call_with_txn!(context)
+      rescue ParticleStopped
+        context
+      end
+
+      def call_with_txn!(context = {})
+        ActiveRecord::Base.transaction do
+          self.call!(context)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: laminar-rails
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Robert Lockerd
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-05 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'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+- !ruby/object:Gem::Dependency
+  name: laminar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: 
+email:
+- rmlockerd@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemfiles/rails42.gemfile
+- gemfiles/rails50.gemfile
+- gemfiles/rails51.gemfile
+- gemfiles/rails52.gemfile
+- laminar-rails.gemspec
+- lib/generators/common_generator.rb
+- lib/generators/laminar/flow/USAGE
+- lib/generators/laminar/flow/flow_generator.rb
+- lib/generators/laminar/particle/USAGE
+- lib/generators/laminar/particle/particle_generator.rb
+- lib/generators/templates/flow.erb
+- lib/generators/templates/particle.erb
+- lib/generators/templates/spec.erb
+- lib/laminar/rails.rb
+- lib/laminar/rails/version.rb
+- lib/laminar/transacticle.rb
+homepage: https://github.com/rmlockerd/laminar-rails
+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.11
+signing_key: 
+specification_version: 4
+summary: Laminar gem support for Rails applications.
+test_files: []