action_sprout-method_object 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2af61d8a38e0e94379be30cb4aabc27c6dc534db
+  data.tar.gz: ec05db54b02953043c80f7f94b14332a1944d830
+SHA512:
+  metadata.gz: 381681d5212e72df9b7272ab874d7639ddb4cbd7e4994c4d64af680e2789874cba2dfcb04df9fc0090be6085760c9b4709eb8d417ac7ee97a1a4c24f3a70b18a
+  data.tar.gz: 7bba91f5a3ed1c31bb63f8659ed3e12450cc209ed93c99ba775aacd4851262ca2c1ee510312a2f572be4f17373f3215df1710f3f4775ee75f8ed780d9abaf5e4

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,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.3

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Amiel Martin
+
+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,112 @@
+# ActionSprout::MethodObject
+
+A simple class method that makes it super easy to create a method object taking keyword attributes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'action_sprout-method_object'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install action_sprout-method_object
+
+## Usage
+
+MethodObject is a quick shortcut for creating "method objects". Under the hood, it uses kwattr. Check out the [kwattr docs][] for how to configure options.
+
+[kwattr docs]: https://github.com/etiennebarrie/kwattr
+
+Example:
+
+```ruby
+class SaveUser
+  method_object :user, repository: UserRepository.new
+
+  def call
+    repository.save user
+  end
+end
+
+SaveUser.call user: user
+```
+
+### Summary of kwattr options:
+
+`kwattr` stands for key-word-attributes and therefore only supports setting up method objects that take keyword arguments. Each positional argument passed to `method_object` represents a required attribute, and each keyword argument passed to `method_object` represents an option attribute and its default.
+
+### Block support
+
+A block may be passed to the `call` class method. This block will be passed directly to the `call` instance method. For example:
+
+```ruby
+class ParseConfiguration
+  method_object :name
+
+  def call
+    yield configuration
+  end
+
+  private
+
+  def configuration
+    YAML.load_file(file_name)[Rails.env]
+  end
+
+  def file_name
+    Rails.root.join('config', name).to_s
+  end
+end
+
+ParseConfiguration.call(name: 'user-config') do |config|
+  # do something with config
+end
+```
+
+### Usage without Rails
+
+In a Ruby on Rails project, the `method_object` class method is automatically available. Outside of Rails, an extra step is necessary.
+
+`MethodObject` can be included directly in a specific class.
+
+```ruby
+class SaveUser
+  extend ActionSprout::MethodObject
+  method_object :user, repository: UserRepository.new
+
+  def call
+    repository.save user
+  end
+end
+
+SaveUser.call user: user
+```
+
+Or, to make `method_object` available on all class, include it in `Module` somewhere in initialization.
+
+```ruby
+Module.include ActionSprout::MethodObject
+```
+
+## 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/Amiel Martin/action_sprout-method_object. 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/action_sprout-method_object.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'action_sprout/method_object/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "action_sprout-method_object"
+  spec.version       = ActionSprout::MethodObject::VERSION
+  spec.authors       = ["Amiel Martin"]
+  spec.email         = ["amiel@actionsprout.com"]
+
+  spec.summary       = %q{Method objects, the way we do them at ActionSprout}
+  spec.description   = %q{A simple class method that makes it super easy to create a method object taking keyword attributes.}
+  spec.homepage      = "https://github.com/ActionSprout/action_sprout-method_object"
+  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.require_paths = ["lib"]
+
+  spec.add_dependency 'kwattr'
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

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

@@ -0,0 +1,42 @@
+require 'action_sprout/method_object/version'
+require 'kwattr'
+require 'action_sprout/method_object/railtie' if defined?(Rails)
+
+module ActionSprout
+  # MethodObject is a quick shortcut for creating "method objects". Under the
+  # hood, it uses kwattr. Check out the [kwattr docs][] for how to configure
+  # options.
+  #
+  # [kwattr docs]: https://github.com/etiennebarrie/kwattr
+  #
+  # Example:
+  #
+  #   class SaveUser
+  #     method_object :user, repository: UserRepository.new
+  #
+  #     def call
+  #       repository.save user
+  #     end
+  #   end
+  #
+  #   SaveUser.call user: user
+  #
+  # Summary of kwattr options:
+  #
+  # kwattr stands for key-word-attributes and therefore only supports setting up
+  # method objects that take keyword arguments. Each positional argument passed
+  # to method_object represents a required attribute, and each keyword argument
+  # passed to method_object represents an option attribute and its default.
+  module MethodObject
+    def method_object(*args)
+      extend ClassMethods
+      kwattr(*args)
+    end
+
+    module ClassMethods
+      def call(**args, &block)
+        new(**args).call(&block)
+      end
+    end
+  end
+end

data/lib/action_sprout/method_object/railtie.rb

@@ -0,0 +1,12 @@
+require 'rails/railtie'
+
+module ActionSprout
+  module MethodObject
+    class Railtie < Rails::Railtie
+      initializer 'action_sprout-method_object.initialize' do
+        Module.include ActionSprout::MethodObject
+      end
+    end
+  end
+end
+

data/lib/action_sprout/method_object/version.rb

@@ -0,0 +1,5 @@
+module ActionSprout
+  module MethodObject
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: action_sprout-method_object
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Amiel Martin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kwattr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+description: A simple class method that makes it super easy to create a method object
+  taking keyword attributes.
+email:
+- amiel@actionsprout.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- action_sprout-method_object.gemspec
+- bin/console
+- bin/setup
+- lib/action_sprout/method_object.rb
+- lib/action_sprout/method_object/railtie.rb
+- lib/action_sprout/method_object/version.rb
+homepage: https://github.com/ActionSprout/action_sprout-method_object
+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.8
+signing_key: 
+specification_version: 4
+summary: Method objects, the way we do them at ActionSprout
+test_files: []