operatic 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5f46398654b0cda4099550dc86d85e82833fa9671722f901dfeb09a0c9ef6e5
-  data.tar.gz: c5098edb779caedbefc2ddf39861ffd6e005315f5928da73b5eaaa04046c68fc
+  metadata.gz: 3d2d761cb5faa5c2c3033b701c7a716390cdefba8ebf2c13bbd20086375c81ff
+  data.tar.gz: 854bfdfc81e9c54866dc70f1c8773d11a664648e20d3bb33bab2a5fd4ca093fd
 SHA512:
-  metadata.gz: 93c89546ab8bc0a51fd1e58e059a5ec5da145443fdffadc4072e8af304fad195d1034f31b37a446870fe7e230292d7a40bf0168cfc1cc536ceab4e7b251907fb
-  data.tar.gz: 8a14b3e513e2416c55fc768612f0445697da7dabd331594d651c88f8da42c866db3bef42933d22ba44b3ef29b37dc5a6aa77b00af93360b7738c1563d32280c3
+  metadata.gz: cd7219716eaf92d39c26a9bd7072a90eb45a3d95c86fc784c2c94de6645b4bd1c3b7dc8fb7d802fafd59db93532b96cb3ee4f5a93cd1e4a30973146244fd165e
+  data.tar.gz: 139a4f9bf2cddaec695fed7095b6460aa2b3cf5433980e327a05fa0ebeddedab7d53df934c07fe5c835eb57f935d2c5153fdc5e6c3cdd2bd5a22e630c86097a9

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# CHANGELOG
+
+## Version 0.3.0 - 2019-11-27
+
+- Implement `#to_h` not `#to_hash`. <https://github.com/benpickles/operatic/pull/4>
+
+## Version 0.2.0 - 2019-11-23
+
+First official version hosted on [RubyGems.org](https://rubygems.org/gems/operatic).

data/README.md

@@ -2,6 +2,8 @@
 
 [![GitHub Actions status](https://github.com/benpickles/operatic/workflows/Ruby/badge.svg)](https://github.com/benpickles/operatic)
 
+A minimal standard interface for your operations.
+
 ## Installation
 
 Add Operatic to your application's Gemfile and run `bundle install`.
@@ -36,13 +38,13 @@ end
 result = SayHello.call(name: 'Dave')
 result.success? # => true
 result.message  # => "Hello Dave"
-result.to_hash  # => {:message=>"Hello Dave"}
+result.to_h     # => {:message=>"Hello Dave"}
 
 result = SayHello.call
 result.failure? # => true
 result.success? # => false
 result.message  # => nil
-result.to_hash  # => {}
+result.to_h     # => {}
 ```
 
 A Rails controller might use Operatic like this:

data/lib/operatic/result.rb

@@ -69,11 +69,11 @@ module Operatic
       @success
     end
 
-    # Returns the full hash of data attached to the result via {#success!},
-    # {#failure!}, or convenience accessors added with {.generate}.
+    # Returns the full (frozen) hash of data attached to the result via
+    # {#success!}, {#failure!}, or convenience accessors added with {.generate}.
     #
     # @return [Hash]
-    def to_hash
+    def to_h
       @data
     end
 

data/lib/operatic/version.rb

@@ -1,3 +1,3 @@
 module Operatic
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/operatic.rb

@@ -17,7 +17,7 @@ module Operatic
     # @param attrs [Hash<Symbol, anything>] an optional hash of key/values to
     #   to the result. The class must have corresponding +attr_reader+s
     #
-    # @return a [Result] which is fro
+    # @return a [Result]
     def call(attrs = nil)
       new(attrs)
         .tap(&:call)
@@ -95,12 +95,12 @@ module Operatic
   #
   #   result = SayHello.call(name: 'Dave')
   #   result.success? # => true
-  #   result.to_hash  # => {:message=>"Hello Dave"}
+  #   result.to_h     # => {:message=>"Hello Dave"}
   #
   #   result = SayHello.call
   #   result.failure? # => true
   #   result.success? # => false
-  #   result.to_hash  # => {}
+  #   result.to_h     # => {}
   def call
   end
 

data/operatic.gemspec

@@ -8,22 +8,22 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Ben Pickles']
   spec.email         = ['spideryoung@gmail.com']
 
-  spec.summary       = 'Operations'
-  spec.description   = ''
+  spec.summary       = 'A minimal standard interface for your operations'
+  spec.description   = spec.summary
   spec.homepage      = 'https://github.com/benpickles/operatic'
   spec.license       = 'MIT'
 
-  # spec.metadata['allowed_push_host'] = 'TODO: Set to 'http://mygemserver.com''
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  # spec.metadata['source_code_uri'] = 'TODO: Put your gem's public repo URL here.'
-  # spec.metadata['changelog_uri'] = 'TODO: Put your gem's CHANGELOG.md URL here.'
+  spec.metadata = {
+    'changelog_uri'     => 'https://github.com/benpickles/operatic/blob/master/CHANGELOG.md',
+    'documentation_uri' => 'https://rubydoc.info/gems/operatic',
+    'source_code_uri'   => 'https://github.com/benpickles/operatic',
+  }
 
   spec.required_ruby_version = '>= 2.5.0'
 
   # 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
+  spec.files         = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = 'exe'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: operatic
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ben Pickles
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-23 00:00:00.000000000 Z
+date: 2019-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: ''
+description: A minimal standard interface for your operations
 email:
 - spideryoung@gmail.com
 executables: []
@@ -62,6 +62,7 @@ files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -78,7 +79,9 @@ homepage: https://github.com/benpickles/operatic
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/benpickles/operatic
+  changelog_uri: https://github.com/benpickles/operatic/blob/master/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/operatic
+  source_code_uri: https://github.com/benpickles/operatic
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -97,5 +100,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Operations
+summary: A minimal standard interface for your operations
 test_files: []