to_collection 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7f4554abcadb801dd15c605c27fd9f2136afe4af6daaeceae11c1acf0f4e81d
-  data.tar.gz: 450a6c4275d9f288a9ad12d0206b4bae758b53ed4bc4fb0235405e6630124f9e
+  metadata.gz: 0f47b3f3b4c1dac9e8a35181d9286a03ff0fc246179ec73eb842378f6e2b9da2
+  data.tar.gz: 6521e3dd2db1ca1ae61719842ac225253bbb54dc38b958765c759129d6495cb8
 SHA512:
-  metadata.gz: 0ba415baef5dabf5bbf237d5f6bace35f8942db4198125e119c7ad465ef037d371b199537b09a81582129363da2a1934c481ba897302805a8558c062faa608c1
-  data.tar.gz: a1db7fd8b9762c1d595c23041fab690b379711500e814ac8681d6e7d0d610f60c3350add4e1212dc313bb954de91da3c98dc4941395e03e9e51fc002b3cbce62
+  metadata.gz: 69bc9ff83efa0d7eafa084d3680020a0f8531e0856c80d4de524b40553812de76f82261609616b27cfb4f42653086e9b5145c148d0b3de056ef632cf04f20862
+  data.tar.gz: abb6bcf672a80e01768ef20da26e5485258042d814cab8eef0784a382b494f23d6e43cc021171d1ee014c144df044c7b522d350b15670b3b14bedbc57288db69

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+### v2.0.1
+
+- Opal support via monkey-patching
+
+### 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

data/LICENSE

@@ -1,5 +1,3 @@
-MIT License
-
 Copyright (c) 2017-2020 Andy Maleh
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

data/README.md

@@ -1,4 +1,4 @@
-# ToCollection 2.0.0 Ruby Refinement
+# ToCollection 2.0.1 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)
@@ -9,6 +9,8 @@ Especially useful in processing REST Web Service API JSON responses in a uniform
 
 `ToCollection` is a Ruby Refinement, so it may be safely enabled via `using ToCollection` where needed only.
 
+Now also supports [Opal Ruby](https://opalrb.com) by degrading gracefully to monkey-patching.
+
 ## Introduction
 
 Canonicalize data to treat uniformly whether it comes in as a single object or an array of objects, dropping `nils` out automatically.
@@ -44,20 +46,26 @@ end
 
 ### Bundler
 
-- Add `gem 'to_collection', '~> 2.0.0'` to Gemfile
+- Add `gem 'to_collection', '~> 2.0.1'` 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.
 
 ### Manual Gem Install
 
-- Run `gem install to_collection -v2.0.0`
+- Run `gem install to_collection -v2.0.1`
 - 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.
 
+### Opal Ruby
+
+- Follow the first step in [Bundler](#bundler) or [Manual Gem Install](#manual-gem-install) instructions to add the gem.
+- Add Opal.use_gem 'to_collection' to "config/initializers/assets.rb" in Rails unless using as part of another gem.
+- Add `require 'to_collection'` to code (this adds the functionality via monkey-patching not refinements in [Opal](https://opalrb.com))
+
 ### Note
 
-If '#to_collection' was already defined on `Object` in a project, requiring the `to_collection` library will print a warning. 
+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.
 
@@ -261,20 +269,12 @@ You asked for "Elegant" didn't you? I hope that was what you were looking for.
 
 ## How It Works
 
-A Ruby Refinement is activated via `using ToCollection` adding/overwriting the `#to_collection` method in `Object`, which 
+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
+## Change Log
 
-- 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
+[CHANGELOG.md](CHANGELOG.md)
 
 ## Contributing
 
@@ -290,5 +290,6 @@ is the ancestor of all Ruby objects.
 
 ## Copyright
 
-Copyright (c) 2017-2020 Andy Maleh. See LICENSE.txt for
-further details.
+[MIT](LICENSE.txt)
+
+Copyright (c) 2017-2020 Andy Maleh.

data/VERSION

@@ -0,0 +1 @@
+2.0.1

data/lib/to_collection.rb

@@ -1,6 +1,29 @@
-# require 'super_module'
+# 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
+# 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.
 
 module ToCollection
+  if RUBY_PLATFORM == 'opal'
+    def self.refine(class_or_module, &refinement)
+      class_or_module.class_eval(&refinement)
+    end
+  end
   refine Object do
     begin
       method(:to_collection)
@@ -15,3 +38,10 @@ module ToCollection
     end
   end
 end
+
+if RUBY_PLATFORM == 'opal'
+  # Create a shim `using` method that does nothing since we monkey-patch in Opal earlier in the `refine` method
+  def self.using(refinement)
+    # NO OP
+  end
+end

data/to_collection.gemspec

@@ -0,0 +1,48 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: to_collection 2.0.1 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "to_collection".freeze
+  s.version = "2.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Andy Maleh".freeze]
+  s.date = "2020-12-09"
+  s.description = "ToCollection Ruby Refinement - Treat an array of objects and a singular object uniformly as a collection of objects".freeze
+  s.email = "andy.am@gmail.com".freeze
+  s.extra_rdoc_files = [
+    "CHANGELOG.md",
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    "CHANGELOG.md",
+    "README.md",
+    "VERSION",
+    "lib/to_collection.rb",
+    "to_collection.gemspec"
+  ]
+  s.homepage = "http://github.com/AndyObtiva/to_collection".freeze
+  s.licenses = ["MIT".freeze]
+  s.rubygems_version = "3.1.4".freeze
+  s.summary = "ToCollection Ruby Refinement - Treat an array of objects and a singular object uniformly as a collection of objects".freeze
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+  end
+
+  if s.respond_to? :add_runtime_dependency then
+    s.add_development_dependency(%q<jeweler>.freeze, ["~> 2.3.3"])
+    s.add_development_dependency(%q<coveralls>.freeze, ["~> 0.8.19"])
+    s.add_development_dependency(%q<rspec>.freeze, ["~> 3.5.0"])
+  else
+    s.add_dependency(%q<jeweler>.freeze, ["~> 2.3.3"])
+    s.add_dependency(%q<coveralls>.freeze, ["~> 0.8.19"])
+    s.add_dependency(%q<rspec>.freeze, ["~> 3.5.0"])
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: to_collection
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Andy Maleh
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-29 00:00:00.000000000 Z
+date: 2020-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jeweler
@@ -58,17 +58,21 @@ email: andy.am@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
+- CHANGELOG.md
 - LICENSE
 - README.md
 files:
+- CHANGELOG.md
 - LICENSE
 - README.md
+- VERSION
 - lib/to_collection.rb
+- to_collection.gemspec
 homepage: http://github.com/AndyObtiva/to_collection
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -83,8 +87,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: ToCollection Ruby Refinement - Treat an array of objects and a singular object
   uniformly as a collection of objects