uncouple 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 928317f2195176bad12b1b7c6d46b7ad71b1482c
+  data.tar.gz: d694b364a751cdae7dc60c7d0922ce825809eeda
+SHA512:
+  metadata.gz: 62db4c8201c0616b2ff6c2eec3adff326db3b5f7522ff72f6128e71018f3d9d1f2132e65597c52ad35a3eca4c165628b657156a1711d7c8c999ab74f67d83c8e
+  data.tar.gz: a39acbcfe9658e2446f603bd91c01a2ad0358e2efaba5d781ff98b33bfcecb15f50e0462cce8e32380233dc747f6c3387c776f1c56bc5d44c4e1446cd14ca770

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+  - 2.3.1
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6
+script: bundle exec rspec spec

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 spencer@nightout.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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in uncouple.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Spencer Steffen
+
+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,118 @@
+# Uncouple
+
+[![Build Status](https://travis-ci.org/citrus/slavery.svg?branch=master)](https://travis-ci.org/citrus/slavery)
+
+Uncouple your business logic from rails.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'uncouple'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install uncouple
+
+
+## Usage
+
+Create actions in `app/actions/:model_name/:action_name`. If you're on rails, you can use the included generator:
+
+```sh
+rails generate uncouple:action metric/create
+```
+
+Use actions to encapsulate your business logic.
+
+```rb
+# app/actions/metric/create_action.rb
+class Metric::CreateAction < Metric::NewAction
+
+  def perform
+    create_metric!
+    notify! if params[:notify]
+  end
+
+  def create_metric!
+    @metric = Metric.create(metric_params)
+  end
+
+  def notify!
+    NewMetricMailer.notification(@metric).deliver
+  end
+
+  def success?
+    metric.try(:persisted?)
+  end
+
+private
+
+  def metric_params
+    params.require(:metric).permit(:name, :value)
+  end
+
+end
+```
+
+
+##### Then invoke these actions wherever needed...
+
+In the console:
+
+```ruby
+action = Metric::CreateAction.new(metric: { name: "RPM", value: 5 })
+action.perform
+action.success?
+```
+
+Or in the controller using the [Uncouple::ActionPerformer](https://github.com/citrus/uncouple/blob/master/lib/uncouple/action_performer.rb)
+
+```rb
+# app/controllers/metrics_controller.rb
+class MetricsController < ApplicationController
+
+  include Uncouple::ActionPerformer
+
+  def create
+    perform Metric::CreateAction do
+      return redirect_to(metrics_path)
+    end
+    render :new
+  end
+
+end
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+## Testing
+
+Tests can be run with rspec:
+
+```sh
+bundle exec rspec
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/citrus/uncouple. 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/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 "uncouple"
+
+# 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/uncouple.rb

@@ -0,0 +1,6 @@
+require "uncouple/version"
+require "uncouple/action"
+require "uncouple/action_performer"
+
+module Uncouple
+end

data/lib/uncouple/action.rb

@@ -0,0 +1,32 @@
+module Uncouple
+  class Action
+
+    attr_reader :params
+
+    def initialize(params=nil)
+      @params = convert_to_strong_parameters(params)
+    end
+
+    def perform
+      raise NotImplementedError, "Overwrite `perform` in your action. Params: #{params}"
+    end
+
+    def success?
+      @success
+    end
+
+    def failure?
+      !success?
+    end
+
+  private
+
+    def convert_to_strong_parameters(params)
+      return if params.nil?
+      return params unless defined?(ActionController::Parameters)
+      return params if params.is_a?(ActionController::Parameters)
+      ActionController::Parameters.new(params)
+    end
+
+  end
+end

data/lib/uncouple/action_performer.rb

@@ -0,0 +1,14 @@
+module Uncouple
+  module ActionPerformer
+
+    def perform(action_class, action_params=nil, &block)
+      action_params ||= params if respond_to?(:params)
+      if @action = action_class.new(action_params)
+        @action.perform
+        block.call if block_given? && @action.success?
+      end
+      @action
+    end
+
+  end
+end

data/lib/uncouple/rails.rb

@@ -0,0 +1,2 @@
+require "uncouple"
+require "uncouple/rails/railtie" if defined?(Rails)

data/lib/uncouple/rails/generators/action_generator.rb

@@ -0,0 +1,22 @@
+module Uncouple
+  module Generators
+    class Action < Rails::Generators::Base
+
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      attr_accessor :name
+
+      desc "Generates an action."
+
+      def action_generator
+        self.name = args.first.to_s.downcase
+        raise "Invalid Action Name" if name.blank?
+        template "app/actions/action.rb", "app/actions/#{name}_action.rb"
+        if defined?(RSpec)
+          template "spec/actions/action_spec.rb", "spec/actions/#{name}_action_spec.rb"
+        end
+      end
+
+    end
+  end
+end

data/lib/uncouple/rails/generators/templates/app/actions/action.rb

@@ -0,0 +1,15 @@
+# <%= destination %>
+class <%= name.classify %>Action < Uncouple::Action
+
+  # Use attr_reader to access your instances outside the action
+  # attr_reader :some_instance
+
+  def perform
+    # TODO: implement the core of your action here
+  end
+
+  # def success?
+    # Overwrite me with a custom success check, or set @success in `perform`.
+  # end
+
+end

data/lib/uncouple/rails/generators/templates/spec/actions/action_spec.rb

@@ -0,0 +1,5 @@
+require 'rails_helper'
+
+RSpec.describe <%= name.classify %>Action, type: :action do
+  # TODO: write some useful starting points
+end

data/lib/uncouple/rails/railtie.rb

@@ -0,0 +1,15 @@
+class Uncouple::Railtie < Rails::Railtie
+
+  initializer "uncouple.configure_rails_initialization" do
+
+  end
+
+  rake_tasks do
+
+  end
+
+  generators do
+    require "uncouple/rails/generators/action_generator"
+  end
+
+end

data/lib/uncouple/version.rb

@@ -0,0 +1,3 @@
+module Uncouple
+  VERSION = "0.1.0"
+end

data/uncouple.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'uncouple/version'
+
+Gem::Specification.new do |spec|
+
+  spec.name          = "uncouple"
+  spec.version       = Uncouple::VERSION
+  spec.authors       = ["Spencer Steffen"]
+  spec.email         = ["spencer@nightout.com"]
+
+  spec.summary       = %q{Uncouple your business logic from rails.}
+  spec.description   = %q{Uncouple your business logic from rails.}
+  spec.homepage      = "https://github.com/citrus/uncouple"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "strong_parameters", "~> 0.2.0"
+
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: uncouple
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Spencer Steffen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: strong_parameters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: Uncouple your business logic from rails.
+email:
+- spencer@nightout.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/uncouple.rb
+- lib/uncouple/action.rb
+- lib/uncouple/action_performer.rb
+- lib/uncouple/rails.rb
+- lib/uncouple/rails/generators/action_generator.rb
+- lib/uncouple/rails/generators/templates/app/actions/action.rb
+- lib/uncouple/rails/generators/templates/spec/actions/action_spec.rb
+- lib/uncouple/rails/railtie.rb
+- lib/uncouple/version.rb
+- uncouple.gemspec
+homepage: https://github.com/citrus/uncouple
+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: Uncouple your business logic from rails.
+test_files: []