operate 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d93185f6ff1d022b5511ba6f6fbd2e815e27eaf1
-  data.tar.gz: d0ba09ef7bb5723dc5e0302847dd0c635c28191d
+  metadata.gz: e4ae06d376016ee482b1fe2c0fb7d15304f96f77
+  data.tar.gz: '01248b745836660db7dedb802bf25de16d7c77a8'
 SHA512:
-  metadata.gz: ee4756b459c0db03be97b7e581ad4e7d27fbc9202bc5e661f393f55f806f66cedd489ea9d25b4ec89ad91b5f0f56c6cdc48bcfd4d627e04c0c5b8fcc7ccee943
-  data.tar.gz: 8daae04166fe135d2f4e70b3d37946bcbb24291834a91371b87d44cc55e999f0f5b87d43379ad115da0840e583376f4a5825405072b29179e3c87edc1ccb8f2d
+  metadata.gz: 4b503d5be289f23dce63009daf120dedad7081ad42993d6934314d051f0dc2b9f0c8e68d21da81fe458fc2335e61384fa100b4cdfaa7e06309882de0970906fb
+  data.tar.gz: 8f3c185e0a3b2f92e0d1a8384d8f91363f5562ad6028a6337cbe979fe73d9fdcfdf381a7777d7be8c8f34a85e0ab23624163cf5b8b91c2e4cc03eb7aad00c342

data/.gitignore

@@ -7,6 +7,6 @@
 /pkg/
 /spec/reports/
 /tmp/
-
+/operate*gem
 # rspec failure tracking
 .rspec_status

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Operate Changelog
+
+
+## [0.1.1] - October 27, 2017
+
+- dependency on ActiveSupport::Concern removed
+- ActiveRecord no longer required: if ActiveRecord is not available, `Operate::Command#transaction(&block)` is disabled
+
+
+## 0.1.0 - September 27, 2017
+
+- Initial release
+
+
+[0.1.1]: https://github.com/tomichj/operate/compare/0.1.0...0.1.1

data/README.md

@@ -2,21 +2,29 @@
 
 Operate is a gem to help create [service objects].
 
-Use Operate to __remove all business logic from your controller and model__, subsuming it in an Operate-based 
-class that represents your processes. Examples might be: a user addition, a post addition, or adding  a comment.  
+[![Gem Version](https://badge.fury.io/rb/operate.svg)](https://badge.fury.io/rb/operate) ![Build status](https://travis-ci.org/tomichj/operate.svg?branch=master) ![Code Climate](https://codeclimate.com/github/tomichj/operate/badges/gpa.svg)
+
+Use Operate to __remove business logic from your controller and model__, subsuming it in Operate-based 
+"service" object that represents your processes. Examples might be: a user addition, a post addition, 
+or adding a comment.  
 
 Service objects can out factor behavior that would bloat models or controllers, and is a useful step to patterns
 like Strategy and Command.
 
-Operate is in the very earliest stages of development. Additional features will be added. The core API 
-exposed via `Operate::Command` is solid and no changes are in the words.
+Service objects are not a new concept, and extracting controller bloat to service objects is a common 
+refactoring pattern. This [Arkency blog post] describes extracting service objects using SimpleDelegator, a
+useful pattern. Operate can assist you with process, further refining it: rather than raising exceptions in your
+service object, and rescuing exceptions in your controller, we broadcast and subscribe to events.
+
+Operate is in the very earliest stages of development. Additional features will be added. The current API 
+exposed via `Operate::Command`, however, is solid and no breaking changes there are anticipated.
 
 
 ## Dependencies
 
-Operate requires:
-* `ActiveRecord` 4.2 or greater
-* `ActiveSupport` 4.2 or greater
+Operate requires only `ActiveSupport` 4.2 or greater.
+
+Additionally, if ActiveRecord is available, transactions are supported. There is no explicit support for other ORMs.
 
 It's not required, but a form object library like [Reform] is recommended. Reform is used in the examples below.
 
@@ -44,16 +52,17 @@ Just `include Operate::Command` in your class. Operate's api provides:
 
 Methods used in your service class:
 * `self#call(*args, &block)` will initialize your service class with *args and invoke #call
-* `#broadcast(:event, *args)` that will broadcast an event to a subscriber
-* `#transaction(&block)` that wraps a block inside a transaction
+* `#broadcast(:event, *args)` will broadcast an event to a subscriber (see `on` below)
+* `#transaction(&block)` wraps a block with an `ActiveRecord::Base.transaction` (only if ActiveRecord is available)
 
-Methods used by clients of your service class:
+Methods used by clients (normally a controller) of your service class:
 * `#on(*events, &block)` that subscribe to an event or events, and provide a block to handle that event
 
 
 An example service:
 
 ```ruby
+# put in app/services, app/commands, or something like that
 class UserAddition
   include Operate::Command
   
@@ -63,7 +72,7 @@ class UserAddition
   end
   
   def call
-    return broadcast(:invalid) unless @form.validate(@params)
+    return broadcast(:invalid) unless @form.validate(@params[:user])
     
     transaction do
       create_user
@@ -102,6 +111,8 @@ class UserController < ApplicationController
 end
 ```
 
+Note: this example does not use [Strong Parameters] as [Reform] provides an explicit form property layout.
+
 
 ## Credit
 
@@ -117,11 +128,20 @@ This project is intended to be a safe, welcoming space for collaboration, and co
 expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
+## Contributors
+
+Many thanks to:
+
+* [k3rni](https://github.com/k3rni) made ActiveRecord dependency optional
+
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
 [service objects]: https://gist.github.com/blaix/5764401
+[arkency blog post]: http://blog.arkency.com/2015/05/extract-a-service-object-using-simpledelegator/
 [Reform]: http://trailblazer.to/gems/reform/index.html
+[String Parameters]: https://github.com/rails/strong_parameters
 [rectify]: https://github.com/andypike/rectify
 [wisper]: https://github.com/krisleech/wisper

data/lib/operate/command.rb

@@ -9,13 +9,15 @@ module Operate
   #
   module Command
     include Operate::Pubsub::Publisher
-    extend ActiveSupport::Concern
 
-    module ClassMethods
+    class Error < StandardError; end
+
+    def self.included(target)
+      target.extend ClassMethods
+    end
 
-      #
-      # Call will initialize the class with *args and invoke `call` with no parameters.
-      #
+    module ClassMethods
+      # Call will initialize the class with *args and invoke instance method `call` with no arguments
       def call(*args, &block)
         command = new(*args)
         command.evaluate(&block) if block_given?
@@ -24,7 +26,13 @@ module Operate
     end
 
     def transaction(&block)
-      ActiveRecord::Base.transaction(&block) if block_given?
+      return unless block_given?
+
+      if defined?(ActiveRecord)
+        ::ActiveRecord::Base.transaction(&block)
+      else
+        raise Error, 'Transactions are supported only with ActiveRecord'
+      end
     end
 
     def evaluate(&block)

data/lib/operate/version.rb

@@ -1,3 +1,3 @@
 module Operate
-  VERSION = "0.1.0"
+  VERSION = '0.1.1'
 end

data/operate.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Justin Tomich']
   spec.email         = ['tomichj@gmail.com']
 
-  spec.summary       = 'An operation object.'
-  spec.description   = ''
+  spec.summary       = 'Create service objects with Operate.'
+  spec.description   = 'Create service objects with Operate.'
   spec.homepage      = 'https://github.com/tomichj/operate'
   spec.license       = 'MIT'
 
@@ -29,10 +29,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'activesupport', '>= 4.2.0'
-  spec.add_dependency 'activerecord',  '>= 4.2.0'
-
   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 'activerecord', '>= 4.2.0'
+  spec.add_development_dependency 'sqlite3'
 end

metadata

@@ -1,86 +1,86 @@
 --- !ruby/object:Gem::Specification
 name: operate
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Justin Tomich
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-27 00:00:00.000000000 Z
+date: 2017-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.0
-  type: :runtime
+        version: '1.14'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '1.14'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.0
-  type: :runtime
+        version: '10.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 4.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
-description: ''
+        version: '0'
+description: Create service objects with Operate.
 email:
 - tomichj@gmail.com
 executables: []
@@ -90,6 +90,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -127,5 +128,5 @@ rubyforge_project:
 rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: An operation object.
+summary: Create service objects with Operate.
 test_files: []