chainable_methods 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c5e6dd0aa4131fb05e032f78d8f08987b53ff583
+  data.tar.gz: d1d8166a40ee74921230eb87b300e5e79a9ed2ee
+SHA512:
+  metadata.gz: 61e538c7b45a36cb162482b661383ada02b42cb307d8f4446674170886915132ca92ba92d4269f1d58f798ac08ce1c1c24f01db82e824aae4be27aec006d0f71
+  data.tar.gz: f86214fbb1844b2fce900fb740c2712b40bc33bbd5ebeddf0f2524887223ccc3bdf68aabd8f532ed20a12759a7b5ebd3452b3bfa147409b3c8435ed0825f5949

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,50 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at fabioakita@gmail.com
+. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in chainable_methods.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 AkitaOnRails
+
+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,113 @@
+# Chainable Methods
+
+The Elixir language is doing great and within its many incredible features is the famour "Pipe Operator".
+
+It allows you to do constructs such as this:
+
+```
+1..100_000
+  |> Stream.map(&(&1 * 3))
+  |> Stream.filter(odd?)
+  |> Enum.sum
+```
+
+In a nutshell, this is taking the previous returning value and automatically passing as the first argument of the following function call, so it's equivalent to do this:
+
+```
+Enum.sum(Enum.filter(Enum.map(1..100_000, &(&1 * 3)), odd?))
+```
+
+This is how we would usually do it, but with the Pipe Operator it becomes incredibly more enjoyable and readable to work with and shifts our way of thinking into making small functions in linked chains. (By the way, this example comes straight from [Elixir's Documentation](http://elixir-lang.org/getting-started/enumerables-and-streams.html))
+
+Now, in the Ruby world, we would prefer to do it in a more Object Oriented fashion, with chained methods like this:
+
+```
+object.method_1.method_2(argument).method_3 { |x| do_something(x) }.method_4
+```
+
+This is how we do things in Rails, for example, Arel coming into mind:
+
+```
+User.first.comments.where(created_at: 2.days.ago..Time.current).limit(5)
+```
+
+This pattern involves the methods returning "self" and further methods changing the internal state of the object.
+
+On the other hand, sometimes we would want to just be able to take adhoc returning objects and passing them ahead and isolating on the methods level instead of the objects level. There is a lot of existing discussions so the idea is not to vouch for one option or the other.
+
+In case you want to do the "semi-functional" way, we can do it like this:
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chainable_methods'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chainable_methods
+
+## Usage
+
+```
+# create your Module with composable 'functions'
+module MyModule
+  extend ChainableMethods
+
+  def self.method_a(current_state)
+    # transform the state
+    do_something(current_state)
+  end
+
+  def self.method_b(current_state, other_argument)
+    do_something2(current_state, other_argument)
+  end
+
+  def self.method_c(current_state)
+    yield(current_state)
+  end
+end
+```
+
+And now we can build something like this:
+
+```
+MyModule.
+  chain_from(some_text).
+  upcase. # this calls a method from the string in 'some_text'
+  method_a.
+  method_b("something").
+  method_c { |current_state| do_something3(current_state) }.
+  unwrap
+```
+
+And that's it. This would be the equivalent of doing something more verbose like this:
+
+```
+a = some_text.upcase
+b = MyModule.method_a(a)
+c = MyModule.method_b(b, "something")
+d = MyModule.method_c(c) { |c| do_something3(c) }
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/akitaonrails/chainable_methods. 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/bin/console

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

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/chainable_methods.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chainable_methods/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "chainable_methods"
+  spec.version       = ChainableMethods::VERSION
+  spec.authors       = ["AkitaOnRails"]
+  spec.email         = ["fabioakita@gmail.com"]
+
+  spec.summary       = %q{Just a simple experiment to allow for a behavior similar to Elixir's Pipe Operator but within Ruby's semantics.}
+  spec.description   = %q{The idea is to allow for a more functional way of organizing code within a module and being able to chain those methdos together, where the result of the first method serves as the first argument of the next method in the chain.}
+  spec.homepage      = "http://www.codeminer42.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/chainable_methods/version.rb

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

data/lib/chainable_methods.rb

@@ -0,0 +1,28 @@
+require "chainable_methods/version"
+
+module ChainableMethods
+  def chain_from(initial_state)
+    ChainableMethods::Link.new(initial_state, self)
+  end
+
+  class Link
+    attr_reader :state, :context
+
+    def initialize(object, context)
+      @state   = object
+      @context = context
+    end
+
+    def method_missing(name, *args, &block)
+      if state.respond_to?(name)
+        ChainableMethods::Link.new( state.send(name, *args, &block), context)
+      else
+        ChainableMethods::Link.new( context.send(name, *([state] + args), &block), context )
+      end
+    end
+
+    def unwrap
+      @state
+    end
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: chainable_methods
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- AkitaOnRails
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: The idea is to allow for a more functional way of organizing code within
+  a module and being able to chain those methdos together, where the result of the
+  first method serves as the first argument of the next method in the chain.
+email:
+- fabioakita@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- chainable_methods.gemspec
+- lib/chainable_methods.rb
+- lib/chainable_methods/version.rb
+homepage: http://www.codeminer42.com
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Just a simple experiment to allow for a behavior similar to Elixir's Pipe
+  Operator but within Ruby's semantics.
+test_files: []