necklace 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c437405b1a9c7a7e6469a0ddadc9d55f83d71bed
-  data.tar.gz: 31c0a4d2e599bc23a39030b48797c1b782feb75c
+  metadata.gz: 55f8bb4fe12f5436ceed69e294e00383353c72e4
+  data.tar.gz: 30c503d917f93039cbd2cfdefed3209c10163811
 SHA512:
-  metadata.gz: 1a67b9d08b3004ad8c794a0525c127df0568ecc3a1b010fb5d7dbba0df2c939f34ff23b216aec5ad8ce9b0086cd1fb2d6989c395e8830c88a3140963b65532da
-  data.tar.gz: e5e6d5830ff89a15ff0e4f9ff12326d3cca74491a51a1020bd389c9ab1cf6866ce091b5be979d29717700d61400b9313773b00f1511731300b5b584a70dc1331
+  metadata.gz: cb43fb6ab10775f0003e57910859615fa7d7e62b1075ac39f939b63d88cfcc75b7608197cc02dbe3291e2da57bc21d5a1f6e142cdcbe37e4d9bb72bc1e8b9e15
+  data.tar.gz: d38e77087e6ead1b1257cd0579e8f0dc8666ee73afdd4fd36f7a2ddff2210917dce1ac35c17b35ccd751417a26798059de2c700f86b924c2c06db3ff87a6999c

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+ruby '2.1.5'
+
+# Specify your gem's dependencies in synxis.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    necklace (0.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    method_source (0.8.2)
+    multi_json (1.11.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.4.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.2)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    simplecov (0.9.2)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.9.0)
+    simplecov-html (0.9.0)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  necklace!
+  pry
+  rake
+  rspec
+  simplecov

data/README.md

@@ -0,0 +1,121 @@
+# Necklace
+
+## What/Why
+
+Ports the `->` macro from Clojure to make long chains of Enumerable more
+readable
+
+Usually when chaining method calls in ruby, the names of the methods are
+descriptive and the chain is readable. (Note that this may violate the Law of
+Demeter, but this is simply an example). One can imagine something like
+
+```ruby
+food_processor.add(vinegar)
+              .add(garlic)
+              .add(pepper)
+              .start
+              .drizzle(oil)
+```
+
+Where each method returns `self` and the chain describes the actions.
+
+However, with Enumerable, because the methods are more abstract, readability is
+often sacrificed when chaining operations:
+
+```ruby
+[1, 3, 5, 7, 9].map do |n|
+  n + 1
+end.map do |n|
+  n * 2
+end.map |n|
+  n - 3
+end.select |n|
+  n.even?
+end
+```
+
+Two possible solutions are to name only the inner methods:
+
+```ruby
+[1, 3, 5, 7, 9].map do |n|
+  increment(n)
+end.map do |n|
+  double(n)
+end.map |n|
+  subtract(n, 3)
+end.select |n|
+  n.even?
+end
+```
+
+or extract each transformation in a method and call them inside-out -
+lisp-style:
+
+```ruby
+even(
+  subtract_three(
+    double(
+      incrememnt([1, 3, 5, 7, 9])
+    )
+  )
+)
+```
+
+This last looks a lot like a lisp, and Clojure has a macro to make calls like
+this easier to read:
+
+```clojure
+(-> [1, 3, 5, 7, 9]
+  increment
+  double
+  subtract_three
+  even
+)
+```
+
+**Necklace** attempts to replicate at least some aspects of the Clojure
+threading macros (`->`, `->>`) in ruby so that long chains of enumerable
+transformations can be called without sacrificing readablility.
+
+## Usage
+
+simply `include Necklace` in a class
+
+Then define methods that take each successive result as their argument.
+
+Then call `through` with the enumerable as the first argument and an array of
+symbols corresponding to the method names as the second argument.
+
+```ruby
+through([1, 3, 5, 7, 9],
+        [:increment,
+         :double,
+         :subtract_three,
+         :even
+        ]
+)
+```
+
+## License
+### MIT
+
+```
+Copyright (c) 2015 Stuart Terrett
+
+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/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+desc 'Default: run specs.'
+task :default => :spec
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Generate code coverage'
+RSpec::Core::RakeTask.new(:coverage)

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/necklace.rb

@@ -1,3 +1,7 @@
 module Necklace
-
+  def through(enumerable, methods)
+    methods.reduce(enumerable) do |result, method|
+      send(method, result)
+    end
+  end
 end

data/necklace.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.name        = 'necklace'
+  s.version     = '0.0.1'
+  s.date        = '2010-04-28'
+  s.summary     = "Clojures -> macro for ruby"
+  s.description = "Implements Clojures threading macros for Ruby Enumerable methods"
+  s.authors     = ["Stuart Terrett"]
+  s.email       = 'shterrett@gmail.com'
+  s.files       = ["lib/necklace.rb"]
+  s.homepage    = 'http://github.com/shterrett/necklace'
+  s.license     = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('simplecov')
+  s.add_development_dependency('pry')
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter 'spec/'
+end
+
+# encoding: utf-8
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+Dir['./spec/shared/**/*.rb'].sort.each { |f| require f }
+require_relative '../lib/necklace'
+
+require 'rspec'
+
+RSpec.configure do |config|
+  config.order = 'random'
+end

data/spec/threading_arguments_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe 'Threading enumerable as argument' do
+  it 'passes the given enumerable to the function named by the symbol in an array' do
+    class Test
+      include Necklace
+
+      def increment(numbers)
+        numbers.map { |n| n + 1 }
+      end
+
+      def test_increment
+        through([1, 3, 5, 7, 9],
+                [:increment]
+        )
+      end
+    end
+
+    test = Test.new
+    expect(test.test_increment).to eq([2, 4, 6, 8, 10])
+  end
+
+  it 'passes the result of each method to the next from top to bottom' do
+    class Test
+      include Necklace
+
+      def increment(numbers)
+        numbers.map { |n| n + 1 }
+      end
+
+      def double(numbers)
+        numbers.map { |n| n * 2 }
+      end
+
+      def test_increment_double
+        through([1, 3, 5, 7 , 9],
+                [:increment,
+                 :double
+                ]
+        )
+      end
+
+      def test_double_increment
+        through([1, 3, 5, 7, 9],
+                [:double,
+                 :increment
+                ]
+        )
+      end
+    end
+
+    test = Test.new
+
+    expect(test.test_increment_double).to eq([4, 8, 12, 16, 20])
+    expect(test.test_double_increment).to eq([3, 7, 11, 15, 19])
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: necklace
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Stuart Terrett
@@ -9,14 +9,79 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2010-04-28 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Implements Clojures threading macros for Ruby Enumerable methods
 email: shterrett@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- VERSION
 - lib/necklace.rb
+- necklace.gemspec
+- spec/spec_helper.rb
+- spec/threading_arguments_spec.rb
 homepage: http://github.com/shterrett/necklace
 licenses:
 - MIT
@@ -41,4 +106,6 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Clojures -> macro for ruby
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/threading_arguments_spec.rb