responsibility 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f8b5b58fe0c75ff392eeee922e72ebd697b5e210
+  data.tar.gz: cbf0dcaa8696297f15191e0e28304b7221df5afb
+SHA512:
+  metadata.gz: 81e650119d4e5f0b442e1a006cae04f43eed2bafd9afd84264c356f63ac7330f8841000be780bcc8bb32986711cadbc5ee72c6eb99f9ac00c1b12790dae40eda
+  data.tar.gz: 93cdb5f3448ac67f25b55f1bbf2d9bed19983ca8b9e9445442871c2f6d035db8393c148bafb04bbc4646118150f0d020322bb66eccf311ad1fcbcdb39e533e48

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0.pre.3

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 responsibility.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    responsibility (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (9.1.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.0)
+    pry (0.11.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.5.0)
+      byebug (~> 9.1)
+      pry (~> 0.10)
+    rake (10.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16.a)
+  pry-byebug (~> 3.5)
+  rake (~> 10.0)
+  responsibility!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.0.pre.3

data/README.md

@@ -0,0 +1,65 @@
+# Responsibility
+
+A Responsibility is a class that provides a single piece of functionality,
+as per the Single Responsibility Principle
+[https://en.wikipedia.org/wiki/Single_responsibility_principle]. This class
+provides a single method called "perform", with optional "before" and
+"after" hooks. It also keeps track of any errors set during execution.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'responsibility'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install responsibility
+
+## Usage
+
+A simple example could be something like:
+
+```ruby
+class UserSignupService
+  include Responsibility
+
+  def before
+    unless user.present? && user.valid?
+      errors << "User was not provided or is not valid"
+    end
+  end
+
+  def perform
+    user.save
+  end
+
+  def after
+    UserConfirmationEmailService.perform(email: user.email)
+  end
+end
+
+user = User.new(
+  email: "cerickbrower@gmail.com",
+  password: "Wubba Lubba Dub Dub!"
+)
+result = UserSignupService.perform(user: user)
+
+```
+
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/erickbrower/responsibility.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :console do
+  sh "irb -rubygems -I lib -r responsibility.rb"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "responsibility"
+
+# 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/responsibility.rb

@@ -0,0 +1,12 @@
+require "responsibility/version"
+require "responsibility/initializer"
+require "responsibility/instance_methods"
+require "responsibility/class_methods"
+
+module Responsibility
+  def self.included(base)
+    base.send(:prepend, Initializer)
+    base.include(InstanceMethods)
+    base.extend(ClassMethods)
+  end
+end

data/lib/responsibility/class_methods.rb

@@ -0,0 +1,41 @@
+module Responsibility
+  module ClassMethods
+    def before(obj)
+      if obj.respond_to?(:before)
+        result = obj.before
+        if obj.errors.any?
+          obj.instance_variable_set("@success", false)
+        else
+          obj.instance_variable_set("@success", !!result)
+        end
+      end
+    end
+
+    def after(obj)
+      if obj.respond_to?(:after)
+        result = obj.after
+        if obj.errors.any?
+          obj.instance_variable_set("@success", false)
+        else
+          obj.instance_variable_set("@success", !!result)
+        end
+      end
+    end
+
+    def perform(*args)
+      args = {} if args.is_a?(Array)
+      service = new(args)
+      before(service)
+      if service.success?
+        service.perform
+      end
+      if service.errors.any?
+        service.instance_variable_set("@success", false)
+      end
+      if service.success?
+        after(service)
+      end
+      service
+    end
+  end
+end

data/lib/responsibility/initializer.rb

@@ -0,0 +1,13 @@
+module Responsibility
+  module Initializer
+    def initialize(args)
+      args[:errors] = []
+      args.each do |key, val|
+        self.class.send(:attr_accessor, key)
+        instance_variable_set("@#{key}", val)
+      end
+      self.class.send(:attr_reader, :success)
+      instance_variable_set("@success", true)
+    end
+  end
+end

data/lib/responsibility/instance_methods.rb

@@ -0,0 +1,19 @@
+module Responsibility
+  module InstanceMethods
+    def success?
+      success == true
+    end
+
+    def failure?
+      success == false
+    end
+
+    def fail!
+      success = false
+    end
+
+    def succeed!
+      success = true
+    end
+  end
+end

data/lib/responsibility/version.rb

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

data/responsibility.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "responsibility/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "responsibility"
+  spec.version       = Responsibility::VERSION
+  spec.authors       = ["Erick Brower"]
+  spec.email         = ["cerickbrower@gmail.com"]
+
+  spec.summary       = %q{Provides an interface for creating single purpose objects}
+  spec.description   = <<~HEREDOC
+    A Responsibility is a class that provides a single piece of functionality,
+    as per the Single Responsibility Principle
+    [https://en.wikipedia.org/wiki/Single_responsibility_principle]. This class
+    provides a single method called "perform", with optional "before" and
+    "after" hooks.
+    HEREDOC
+  spec.homepage      = "http://erickbrower.com"
+
+  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.16.a"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry-byebug", "~> 3.5"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: responsibility
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Erick Brower
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+- !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: pry-byebug
+  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'
+description: |
+  A Responsibility is a class that provides a single piece of functionality,
+  as per the Single Responsibility Principle
+  [https://en.wikipedia.org/wiki/Single_responsibility_principle]. This class
+  provides a single method called "perform", with optional "before" and
+  "after" hooks.
+email:
+- cerickbrower@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/responsibility.rb
+- lib/responsibility/class_methods.rb
+- lib/responsibility/initializer.rb
+- lib/responsibility/instance_methods.rb
+- lib/responsibility/version.rb
+- responsibility.gemspec
+homepage: http://erickbrower.com
+licenses: []
+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.13
+signing_key: 
+specification_version: 4
+summary: Provides an interface for creating single purpose objects
+test_files: []