to_collection 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ad1fd3e8472de416d563321f0084ce8fe275260e
-  data.tar.gz: 6c30c469ca163a89db81e87956f868288642f017
+SHA256:
+  metadata.gz: b7f4554abcadb801dd15c605c27fd9f2136afe4af6daaeceae11c1acf0f4e81d
+  data.tar.gz: 450a6c4275d9f288a9ad12d0206b4bae758b53ed4bc4fb0235405e6630124f9e
 SHA512:
-  metadata.gz: a6a1959c4a349cae43f0c4e6287c72d468926d6217720bcee5917cd824259c119a9e4e7fff1d54a0fd48427d713def3d00b5c9e47d43f95bd5625a14cae4f306
-  data.tar.gz: a2f164161fa55f9b099d49def218f58111c575c0932cee4b5eb5e41b4933a269e6197a403fa6fed633ed48055fa4c0133c6269349f1df298cce74f6458c0a2ad
+  metadata.gz: 0ba415baef5dabf5bbf237d5f6bace35f8942db4198125e119c7ad465ef037d371b199537b09a81582129363da2a1934c481ba897302805a8558c062faa608c1
+  data.tar.gz: a1db7fd8b9762c1d595c23041fab690b379711500e814ac8681d6e7d0d610f60c3350add4e1212dc313bb954de91da3c98dc4941395e03e9e51fc002b3cbce62

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 Andy Maleh
+Copyright (c) 2017-2020 Andy Maleh
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,16 +1,19 @@
-# `to_collection`
+# ToCollection 2.0.0 Ruby Refinement
 [![Gem Version](https://badge.fury.io/rb/to_collection.svg)](http://badge.fury.io/rb/to_collection)
 [![Build Status](https://travis-ci.org/AndyObtiva/to_collection.svg?branch=master)](https://travis-ci.org/AndyObtiva/to_collection)
 [![Coverage Status](https://coveralls.io/repos/github/AndyObtiva/to_collection/badge.svg?branch=master)](https://coveralls.io/github/AndyObtiva/to_collection?branch=master)
 
 Treat an array of objects and a singular object uniformly as a collection of objects.
-Especially useful in processing REST Web Service API JSON responses in a functional approach.
+
+Especially useful in processing REST Web Service API JSON responses in a uniform functional approach.
+
+`ToCollection` is a Ruby Refinement, so it may be safely enabled via `using ToCollection` where needed only.
 
 ## Introduction
 
 Canonicalize data to treat uniformly whether it comes in as a single object or an array of objects, dropping `nils` out automatically.
 
-API: `object.to_collection(compact)` where `compact` is a boolean for whether to compact collection or not. It is true by default.
+API: `object#to_collection(compact=true)` where `compact` is a boolean for whether to compact collection or not. It is true by default.
 
 Example:
 
@@ -39,17 +42,24 @@ end
 
 ## Instructions
 
-### Bundler / Rails
+### Bundler
 
-`gem 'to_collection', '~> 1.0.1'`
+- Add `gem 'to_collection', '~> 2.0.0'` to Gemfile
+- Run `bundle`
+- Require `to_collection` ruby gem in code (e.g. via `Bundler.require(:default)` or `require 'bundler/setup'` & `require 'to_collection'`)
+- Add `using ToCollection` to the top of the Ruby file you would like to refine `Object` in with `#to_collection` method.
 
-### Plain Ruby
+### Manual Gem Install
 
-`require 'to_collection'`
+- Run `gem install to_collection -v2.0.0`
+- Add `require 'to_collection'` to code
+- Add `using ToCollection` to the top of the Ruby file you would like to refine `Object` in with `#to_collection` method.
 
 ### Note
 
-Code above enables `#to_collection` method on all classes inheriting from `Object`. See [options](#options) below in case you prefer to **manually** include in certain classes only.
+If '#to_collection' was already defined on `Object` in a project, requiring the `to_collection` library will print a warning. 
+
+It is still safe to require as it does not overwrite `Object#to_collection` except in Ruby files where `using ToCollection` is added.
 
 ## Background
 
@@ -63,7 +73,7 @@ GET /people
 <= 1 person
 JSON Response:
 ```JSON
-{"first_name":"karim","last_name":"akram","city":"Dubai"}
+{"first_name":"John","last_name":"Barber","city":"Chicago"}
 ```
 
 HTTP Request: =>
@@ -75,7 +85,7 @@ GET /people
 JSON Response:
 
 ```JSON
-[{"first_name":"karim","last_name":"akram","city":"Dubai"}, {"first_name":"muhsen","last_name":"asaad","city":"Amman"}, {"first_name":"assaf","last_name":"munir","city":"Qatar"}]
+[{"first_name":"John","last_name":"Barber","city":"Chicago"}, {"first_name":"Mark","last_name":"Jones","city":"New York"}, {"first_name":"Josh","last_name":"Beeswax","city":"Denver"}]
 ```
 
 How do you work with the varied JSON responses in Ruby?
@@ -198,7 +208,7 @@ Example:
 How about go one step further and bake this into all objects using our previous approach of object-oriented polymorphism and Ruby open-classes? That way, we don't just collapse the difference between dealing with arrays of hashes vs hashes but also arrays of objects vs singular objects by adding. Note the use of flatten(1) below to prevent arrays or arrays from collapsing more than one level.
 
 ```ruby
-Object.class_eval do
+class Object
   def to_collection
     [self].flatten(1).compact
   end
@@ -218,7 +228,7 @@ end
 A refactored version including optional compacting would be:
 
 ```ruby
-Object.class_eval do
+class Object
   def to_collection(compact=true)
     collection = [self].flatten(1)
     compact ? collection.compact : collection
@@ -241,77 +251,27 @@ people_http_request.to_collection(false).each do |person|
 end
 ```
 
-You asked for "Elegant" didn't you? I hope that was what you were looking for.
-
-## How It Works
-
-A [super_module](https://github.com/AndyObtiva/super_module) called `ToCollection`
-contains the `#to_collection` method and is included (mixed) into `Object`, providing
-`#to_collection` method to inheriting classes.
-
-## Options
-
-### `Object.to_collection_already_implemented_strategy`
-Possible Values: `"raise_error"` (default), `"keep"`, `"overwrite"`
-
-Setting this option allows developer to configure handling of the case when
-`Object#to_collection` already exists before loading `to_collection` library.
-
-#### `"raise_error"` (default)
-
-For safety reasons, the library will raise AlreadyImplementedError by default to
-alert the developer and provide information about the other options.
-This prevents later surprises and puts control in the hand of the developer to
-responsibly decide what option to pick next.
-
-#### `"keep"`
-
-This keeps existing `to_collection` untouched, disabling this library.
-
-#### `"overwrite"`
-
-This overwrites existing `to_collection` method, fully enabling this library.
-
-### `ENV['TO_COLLECTION_ALREADY_IMPLEMENTED_STRATEGY']`
-Possible Values: `"raise_error"` (default), `"keep"`, `"overwrite"`
-
-Same function as `Object.to_collection_already_implemented_strategy`.
-Environment variable takes precedence over class accessor variable though.
-
-### `ENV['TO_COLLECTION_OBJECT_INCLUDE']`
-Possible Values: `"true"` (default), `"false"`
-
-Must be set before requiring/loading library. When using bundler, ensure `require` option is set to `false` or `nil`.
-
-`ToCollection` [super_module](https://github.com/AndyObtiva/super_module) is automatically included in `Object` except when `ENV['TO_COLLECTION_OBJECT_INCLUDE']` is set to `"false"`, providing developer with the option to **manually** include (mix in) `ToCollection` [super_module](https://github.com/AndyObtiva/super_module) into classes that need it.
-
-Example:
-
-Bundler would have gem require option as false:
+Of course, in Ruby 2+, you may use Ruby Refinements, so simply include `Object#to_collection` via this line instead:
 
 ```ruby
-gem 'to_collection', require: false
+using ToCollection
 ```
 
-Ruby code would then set that environment variable **manually** before requiring library:
+You asked for "Elegant" didn't you? I hope that was what you were looking for.
 
-```ruby
-ENV['TO_COLLECTION_OBJECT_INCLUDE'] = false
-require 'to_collection'
-Hash.instance_eval do
-  include ToCollection #enables to_collection method
-end
-Array.instance_eval do
-  include ToCollection #enables to_collection method
-end
-response_data = people_http_request #returns single hash or array of hashes
-response_data.to_collection.each do |person_hash|
-  # do some work
-end
-```
+## How It Works
+
+A Ruby Refinement is activated via `using ToCollection` adding/overwriting the `#to_collection` method in `Object`, which 
+is the ancestor of all Ruby objects.
 
 ## Release Notes
 
+### v2.0.0
+
+- Revamped API using Ruby Refinements (safer than monkey-patching)
+- Removed `super_module` gem dependency
+- Dropped safety options since Ruby Refinements already handle things safely
+
 ### v1.0.1
 
 - Updated `super_module` gem version to relax indirect `method_source` gem version dependency
@@ -330,5 +290,5 @@ end
 
 ## Copyright
 
-Copyright (c) 2017 Andy Maleh. See LICENSE.txt for
+Copyright (c) 2017-2020 Andy Maleh. See LICENSE.txt for
 further details.

data/lib/to_collection.rb

@@ -1,44 +1,17 @@
-require 'super_module'
+# require 'super_module'
 
-ToCollection = super_module do
-  class AlreadyImplementedError < StandardError
-  end
-
-  def self.to_collection_already_implemented_strategy=(strategy)
-    @to_collection_already_implemented_strategy = strategy
-  end
-
-  def self.to_collection_already_implemented_strategy
-    (ENV['TO_COLLECTION_ALREADY_IMPLEMENTED_STRATEGY'] ||
-      @to_collection_already_implemented_strategy ||
-      :raise_error).to_sym
-  end
-
-  def __to_collection__(compact=true)
-    collection = [self].flatten(1)
-    compact ? collection.compact : collection
-  end
-
-  def self.define_to_collection_method
-    define_method(:to_collection, instance_method(:__to_collection__))
-    send(:remove_method, :__to_collection__)
-  end
-
-  case self.to_collection_already_implemented_strategy
-  when :raise_error
+module ToCollection
+  refine Object do
     begin
-      instance_method(:to_collection)
-      message = "#to_collection is already implemented on Object. Please specify Object.to_collection_already_implemented_strategy or ENV['TO_COLLECTION_ALREADY_IMPLEMENTED_STRATEGY'] as :keep or :overwrite to handle this appropriately."
-      raise AlreadyImplementedError.new(message)
+      method(:to_collection)
+      puts "ToCollection Warning: Object#to_collection already exists! using ToCollection overwrites it with a Ruby Refinement."
     rescue NameError
-      self.define_to_collection_method
+      # No Op
+    ensure
+      def to_collection(compact=true)
+        collection = [self].flatten(1)
+        compact ? collection.compact : collection
+      end
     end
-  when :keep
-    # do nothing
-  when :overwrite
-    self.define_to_collection_method
   end
-
 end
-
-require File.expand_path(File.join(__FILE__, '..', 'ext', 'object'))

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: to_collection
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Andy Maleh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-06 00:00:00.000000000 Z
+date: 2020-05-29 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: super_module
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.2.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.2.2
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
@@ -66,20 +52,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.5.0
-description: "\n    Treat an array of objects and a singular object uniformly as a
-  collection of objects. Especially useful in processing REST Web Service API JSON
-  responses in a functional approach.\n\n    Canonicalize data to treat uniformly
-  whether it comes in as a single object or an array of objects, dropping `nils` out
-  automatically.\n\n    API: `object.to_collection(compact)` where `compact` is a
-  boolean for whether to compact collection or not. It is true by default.\n\n    Example:\n\n
-  \   ```ruby\n    city_counts = {}\n    people_http_request.to_collection.each do
-  |person|\n      city_counts[person[\"city\"]] ||= 0\n      city_counts[person[\"city\"]]
-  += 1\n    end\n    ```\n\n    Wanna keep `nil` values? No problem! Just pass `false`
-  as an argument:\n\n    ```ruby\n    bad_people_count = 0\n    city_counts = {}\n
-  \   people_http_request.to_collection(false).each do |person|\n      if person.nil?\n
-  \       bad_people_count += 1\n      else\n        city_counts[person[\"city\"]]
-  ||= 0\n        city_counts[person[\"city\"]] += 1\n      end\n    end\n    ```\n
-  \ "
+description: ToCollection Ruby Refinement - Treat an array of objects and a singular
+  object uniformly as a collection of objects
 email: andy.am@gmail.com
 executables: []
 extensions: []
@@ -89,7 +63,6 @@ extra_rdoc_files:
 files:
 - LICENSE
 - README.md
-- lib/ext/object.rb
 - lib/to_collection.rb
 homepage: http://github.com/AndyObtiva/to_collection
 licenses:
@@ -110,10 +83,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Treat an array of objects and a singular object uniformly as a collection
-  of objects
+summary: ToCollection Ruby Refinement - Treat an array of objects and a singular object
+  uniformly as a collection of objects
 test_files: []

data/lib/ext/object.rb

@@ -1,6 +0,0 @@
-ENV['TO_COLLECTION_OBJECT_INCLUDE'] ||= 'true'
-if ENV['TO_COLLECTION_OBJECT_INCLUDE'].to_s.downcase == 'true'
-  Object.class_eval do
-    include ToCollection
-  end
-end