persistent-dmnd 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 54b67123bdfe4c297e51b64be972627bbe928facb6b511ffb6f4d6c503190d35
+  data.tar.gz: 9ae346225bfe53de7a2954d0024a90c553757737dd197d1a4fa98bd144611fff
+SHA512:
+  metadata.gz: 4cfee400e6a85861aa5048b19b56bde067c1644a761750546cbf469ef7098ecef8511e407405ae7008712258ebbb8852ad34ae70f26c8a78bfbe17663f4133f0
+  data.tar.gz: 4f5ab905f9ec7e810f463187d76f24d08b0000129c17b90746f5a5f0e68405deaf4275b8c5eb2a7d6badafd64e34debb6b95a8e5972eba04f2e683fd2b0375e8

data/.gitignore

@@ -0,0 +1,28 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+gems.locked
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.5.0

data/.travis.yml

@@ -0,0 +1,23 @@
+language: ruby
+sudo: false
+
+rvm:
+  - jruby-9.1.15.0
+  - 2.5
+  - 2.4
+  - jruby-1.7.9
+  - 1.9.3
+  - 2.3
+  - 2.2
+  - 2.1
+  - 2.0.0
+  - jruby-9.0.0.0
+  - jruby-1.7.27
+  - ruby-head
+  - jruby-head
+
+matrix:
+  allow_failures:
+  - rvm: ruby-head
+  - rvm: jruby-head
+  - rvm: 2.5

data/CODE_OF_CONDUCT.adoc

@@ -0,0 +1,72 @@
+= 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 ivo.anjo@ist.utl.pt. 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
+http://contributor-covenant.org[Contributor Covenant], version 1.4, available at
+http://contributor-covenant.org/version/1/4/.

data/Gemfile

@@ -0,0 +1 @@
+./gems.rb

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Ivo Anjo
+
+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.adoc

@@ -0,0 +1,499 @@
+= Persistent-💎: Because Immutable Data Is Forever
+:toc:
+:toc-placement: macro
+:toclevels: 4
+:toc-title:
+
+image:https://travis-ci.org/ivoanjo/persistent-dmnd.svg?branch=master["Build Status", link="https://travis-ci.org/ivoanjo/persistent-dmnd"] image:https://gemnasium.com/badges/github.com/ivoanjo/persistent-dmnd.svg["Dependency Status", link="https://gemnasium.com/github.com/ivoanjo/persistent-dmnd"]
+
+Are you tired of calling `.freeze` on your data structures (or your colleagues forgetting to do so)? +
+Do you wish Ruby had a literal for creating immutable arrays?
+
+Then persistent-💎 aka _persistent diamond_ is for you!
+
+Persistent-💎 gives you a very tidy way of creating *immutable*...
+
+* *Arrays*:
++
+[source,ruby]
+----
+my_array = a💎[1, 2, 3]
+----
+
+* *Hashes*:
++
+[source,ruby]
+----
+my_hash = h💎[key1: 'foo', key2: 'bar']
+----
+
+* *Sets*:
++
+[source,ruby]
+----
+my_set = s💎[:sephiroth, :kills, :aeris]
+----
+
+...and it behaves as you expect it to:
+
+* You can compare immutable data structures with regular Ruby instances
++
+[source,ruby]
+----
+a💎[1, 2] == [1, 2] && h💎[key1: 'foo'] == {key1: 'foo'} && s💎[:hello] == Set.new([:hello])
+# => true
+----
+
+* You can compare immutable hashes with `<`/`+++<=+++`/`>=`/`>` and with regular Ruby hashes:
++
+[source,ruby]
+----
+h💎[a: 1] < h💎[a: 1, b: 2] && {a: 1, b: 2} < h💎[a: 1, b: 2, c: 3]
+# => true
+----
+
+* You can compare immutable sets with `<`/`+++<=+++`/`>=`/`>` and with regular Ruby sets:
++
+[source,ruby]
+----
+s💎[1] < s💎[1, 2] && Set.new([1, 2]) < s💎[1, 2, 3]
+# => true
+----
+
+* You can splat (`*`) immutable arrays:
++
+[source,ruby]
+----
+def sum(a, b, c)
+  a + b + c
+end
+
+sum(*a💎[1, 2, 39])
+# => 42
+
+sum(1, *a💎[2, 39])
+# => 42
+----
+
+* You can double-splat (`**`) immmutable hashes:
++
+[source,ruby]
+----
+def hello(name:, age:)
+  "Hello there #{name}, you are #{age} years old!"
+end
+
+hello(h💎[name: 'User', age: '50'])
+# => "Hello there User, you are 50 years old!"
+
+hello(name: 'Another User', **h💎[age: '50'])
+# => "Hello there Another User, you are 50 years old!"
+----
+
+Beyond being immutable, these data structures are thread-safe, and can be efficiently copied: when you "update" them, a new copy gets created that shares most of its structure with the original. Thus, creating new instances from existing structures is both memory-efficient and quite fast!
+
+It also (_optionally!_) interoperates with the https://github.com/ruby-concurrency/concurrent-ruby[concurrent-ruby gem], for when you need that extra Oomph (or just thread-safe mutability). See <<concurrent-ruby-interoperability,below>> for more details.
+
+Underneath the covers, persistent-💎 mostly builds atop the awesome https://github.com/hamstergem/hamster[hamster gem].
+Big thanks to its equally-awesome authors!
+
+Persistent-💎 is fully supported and tested on Ruby versions 1.9.3 to 2.5, and JRuby 1.7 to to 9.1. If we don't support your Ruby, it's probably a Python binary. Keep calm and 💎 away!
+
+[discrete]
+== Contents
+
+toc::[]
+
+== Installation
+
+Add this line to your application's `gems.rb` or `Gemfile`:
+
+[source,ruby]
+----
+gem 'persistent-dmnd'
+----
+
+And then execute:
+
+[source,bash]
+----
+$ bundle install
+----
+
+Or install it yourself as:
+
+[source,bash]
+----
+$ gem install persistent-dmnd
+----
+
+This gem is versioned according to http://semver.org/spec/v2.0.0.html[Semantic Versioning].
+
+== Usage
+
+To use persistent-💎, first load it:
+
+[source,ruby]
+----
+require 'persistent-💎'
+# note: you can also use require 'persistent-dmnd'
+----
+
+Persistent-💎 can be added as a module to individual classes (or even to other modules!):
+
+[source,ruby]
+----
+class FooController
+  include Persistent💎
+  # note: you can also use include PersistentDmnd
+
+  ARGUMENTS = a💎[:name, :address, :likes_icecream] # Usable inside this class...
+
+  def stuff
+    a💎[:stuff, :more_stuff] # ...and its methods
+  end
+end
+----
+
+Or you can add it to your whole application by just doing
+
+[source,ruby]
+----
+require 'persistent_dmnd/everywhere'
+
+a💎[:freeeeeeedooooom] # usable everyhere in your application
+----
+
+As you may have noticed, everywhere there is an `💎`, you can replace it with `dmnd`, e.g. `PersistentDmnd` instead of `Persistent💎` for the gem module and for `aDmnd[]` instead of `a💎[]` to create an array.
+
+=== Creating new persistent structures
+
+==== Array
+
+Use `a💎[]` (or `aDmnd[]`) to create a new array:
+
+[source,ruby]
+----
+empty_array = a💎[]
+# => Persistent💎::Array[]
+
+my_array = a💎[:hello, :world]
+# => Persistent💎::Array[:hello, :world]
+----
+
+==== Hash
+
+Use `h💎[]` (or `hDmnd[]`) to create a new hash:
+
+[source,ruby]
+----
+empty_hash = h💎[]
+# => Persistent💎::Hash[]
+
+my_hash = h💎['hello' => 'world']
+# => Persistent💎::Hash["hello" => "world"]
+----
+
+==== Set
+
+Use `s💎[]` (or `sDmnd[]`) to create a new set:
+
+[source,ruby]
+----
+empty_set = s💎[]
+# => Persistent💎::Set[]
+
+2.4.2 :028 > my_set = s💎[:hello, :world]
+# => Persistent💎::Set[:hello, :world]
+----
+
+=== Converting from existing structures
+
+You can use `💎ify[]` (or `dmndify[]`) to convert any received argument to a persistent structure (without modifying the original).
+It is great for getting a protected copy of your input, that you can now store, operate on and share among threads without concern.
+
+It works for all the persistent structures above:
+
+[source,ruby]
+----
+my_array = a💎[:hello, :world]
+💎ify[my_array]
+# => Persistent💎::Array[:hello, :world]
+
+my_hash = h💎['hello' => 'world']
+💎ify[my_hash]
+# => Persistent💎::Hash["hello" => "world"]
+
+my_set = s💎[:hello, :world]
+💎ify[my_set]
+# => Persistent💎::Set[:hello, :world]
+----
+
+It works for regular Ruby arrays (and any object that implements `to_ary()`):
+
+[source,ruby]
+----
+my_array = [:regular, :ruby, :array]
+💎ify[my_array]
+# => Persistent💎::Array[:regular, :ruby, :array] # Not regular any more! :)
+----
+
+It works for regular Ruby hashes (and any object that implements `to_hash()`):
+
+[source,ruby]
+----
+my_hash = {regular: :ruby, hash: nil}
+💎ify[my_hash]
+# => Persistent💎::Hash[:hash => nil, :regular => :ruby]
+----
+
+It works for regular Ruby sets (and any object that implements `to_set()`):
+
+[source,ruby]
+----
+my_set = Set.new([:regular, :ruby, :set])
+💎ify[my_set]
+=> Persistent💎::Set[:regular, :ruby, :set]
+----
+
+And it works for https://github.com/hamstergem/hamster[hamster gem] (`Hamster::Vector`, `Hamster::Hash`, `Hamster::Set`) and https://github.com/ruby-concurrency/concurrent-ruby[concurrent-ruby gem] (`Concurrent::Array`, `Concurrent::Tuple`, `Concurrent::Hash`, `Concurrent::Map`) data structures:
+
+[source,ruby]
+----
+my_vector = Hamster::Vector[1, 2, 3]
+💎ify[my_vector]
+# => Persistent💎::Array[1, 2, 3]
+
+my_array = Concurrent::Array[1, 2, 3]
+💎ify[my_array]
+# => Persistent💎::Array[1, 2, 3]
+
+my_tuple = Concurrent::Tuple.new(1)
+my_tuple.set(0, :hello)
+💎ify[my_tuple]
+# => Persistent💎::Array[:hello]
+
+my_hash = Hamster::Hash[hello: :world]
+💎ify[my_hash]
+# => Persistent💎::Hash[:hello => :world]
+
+my_hash = Concurrent::Hash[hello: :world]
+💎ify[my_hash]
+# => Persistent💎::Hash[:hello => :world]
+
+my_map = Concurrent::Map.new
+my_map[:hello] = :world
+💎ify[my_map]
+# => Persistent💎::Hash[:hello => :world]
+
+my_set = Hamster::Set[:hello, :world]
+💎ify[my_set]
+# => Persistent💎::Set[:hello, :world]
+----
+
+And you can even implement it on your own classes:
+
+[source,ruby]
+----
+class MyList
+  include Persistent💎
+
+  def initialize(item1, item2, item3)
+    @item1 = item1
+    @item2 = item2
+    @item3 = item3
+  end
+
+  def to_💎 # can also be #to_dmnd
+    a💎[@item1, @item2, @item3]
+  end
+end
+
+my_list = MyList.new(:hello, :there, :readers)
+💎ify[my_list]
+# => Persistent💎::Array[:hello, :there, :readers]
+----
+
+=== Converting to regular Ruby structures
+
+The usual `to_a()`/`to_h()`/`to_set()` can be used to convert persistent data structures back to their regular Ruby counterparts:
+
+[source,ruby]
+----
+a💎[1, 2].to_a
+# => [1, 2]
+
+h💎[hello: :world].to_h
+# => {:hello=>:world}
+
+s💎[1, 2].to_set
+# => #<Set: {1, 2}>
+----
+
+=== Converting between persistent structures
+
+All three persistent structures implement `to_a💎()` (or `to_aDmnd()`), `to_h💎()` (or `to_hDmnd()`) and `to_s💎()` (or `to_sDmnd()`) as persistent counterparts for the usual Ruby `to_a()`, `to_h()` and `to_s()`:
+
+[source,ruby]
+----
+a💎[1, 2].to_a💎
+# => Persistent💎::Array[1, 2]
+
+a💎[1, 2].to_s💎
+# => Persistent💎::Set[1, 2]
+
+a💎[['hello', 'world']].to_h💎
+# => Persistent💎::Hash["hello" => "world"]
+
+
+h💎['hello' => 'world'].to_h💎
+# => Persistent💎::Hash["hello" => "world"]
+
+h💎['hello' => 'world'].to_a💎
+# => Persistent💎::Array[Persistent💎::Array["hello", "world"]]
+
+h💎['hello' => 'world'].to_s💎
+# => Persistent💎::Set[Persistent💎::Array["hello", "world"]]
+
+
+s💎[1, 2].to_s💎
+# => Persistent💎::Set[1, 2]
+
+s💎[1, 2].to_a💎
+# => Persistent💎::Array[1, 2]
+
+s💎[['hello', 'world']].to_h💎
+# => Persistent💎::Hash["hello" => "world"]
+----
+
+=== Concurrent Ruby interoperability
+
+When you need to go from thread-safe immutable data structures to thread-safe mutable data structures you can use Persistent-💎's _optional_ interoperability with the https://github.com/ruby-concurrency/concurrent-ruby[concurrent-ruby gem].
+
+You'll need to install concurrent-ruby first, see https://github.com/ruby-concurrency/concurrent-ruby#installation for instructions.
+
+After that, you'll be able to:
+
+==== Array
+
+Use `to_concurrent()` (or `to_concurrent_array()`) to convert your array into a https://ruby-concurrency.github.io/concurrent-ruby/Concurrent/Array.html[`Concurrent::Array`]:
+
+[source,ruby]
+----
+my_array = a💎[:hello, :world]
+my_concurrent_array = my_array.to_concurrent
+----
+
+Use `to_concurrent_tuple()` to convert your array into a https://ruby-concurrency.github.io/concurrent-ruby/Concurrent/Tuple.html[`Concurrent::Tuple`]:
+
+[source,ruby]
+----
+my_array = a💎[:hello, :world]
+my_concurrent_tuple = my_array.to_concurrent_tuple
+# => #<Concurrent::Tuple @size=2, @tuple=[<#Concurrent::AtomicReference value:hello>, <#Concurrent::AtomicReference value:world>]>
+----
+
+==== Hash
+
+Use `to_concurrent()` (or `to_concurrent_hash()`) to convert your hash into a https://ruby-concurrency.github.io/concurrent-ruby/Concurrent/Hash.html[`Concurrent::Hash`]:
+
+[source,ruby]
+----
+my_hash = h💎[hello: :world]
+my_concurrent_hash = my_hash.to_concurrent
+----
+
+Use `to_concurrent_map()` to convert your hash into a https://ruby-concurrency.github.io/concurrent-ruby/Concurrent/Map.html[`Concurrent::Map`]:
+
+[source,ruby]
+----
+my_hash = h💎[hello: :world]
+my_concurrent_map = my_hash.to_concurrent_map
+# => #<Concurrent::Map:0x0055ad9b283ea0 entries=1 default_proc=nil>
+----
+
+=== API documentation for the persistent structures
+
+Because the persistent structures are provided by the awesome https://github.com/hamstergem/hamster[hamster gem], you can refer back to Hamster's API docs for details on the operations provided by each data structure.
+
+==== Array
+
+Built on top of `Hamster::Vector`
+
+* https://github.com/hamstergem/hamster#vector-api-documentation[Example usage]
+* http://rubydoc.info/github/hamstergem/hamster/master/Hamster/Vector[API docs]
+
+==== Hash
+
+Built on top of `Hamster::Hash`
+
+* https://github.com/hamstergem/hamster#hash-api-documentation[Example usage]
+* http://rubydoc.info/github/hamstergem/hamster/master/Hamster/Hash[API docs]
+
+==== Set
+
+Built on top of `Hamster::Set`
+
+* https://github.com/hamstergem/hamster#set-api-documentation[Example usage]
+* http://www.rubydoc.info/github/hamstergem/hamster/master/Hamster/Set[API docs]
+
+== AAARGH YOU FIEND WHY IS THERE AN EMOJI ON MY CODEBASE?
+
+Every printable ascii character is already in use by Ruby, but I didn't want persistent data structures to clutter my source code. I also did not want to use cryptic single, two-letter or three-letter acronyms. Ruby is supposed to be beautifully readable!
+
+Thus, I kept my Ruby beautiful. With two very clear characters you can create an immutable data structure. No more awkward typing of namespaces. No more `.freeze` everywhere. No-one will ever mistake the use of  `💎` for another operation.
+
+Now you can avoid having `💎` on your codebase altogether: just use `dmnd`, as <<usage,suggested above>>.
+
+If you're having a hard time typing the emoji, I recommend just adding a quick snippet to your editor or a quick command to search-and-replace `aDmnd`/`hDmnd`/`sDmnd`/`dmndify` for `a💎`/`h💎`/`s💎`/`💎ify`. That way you get best of both worlds: easy to type, and easy to read!
+
+== Usage on Ruby 1.9
+
+Because of our usage of emojis for method names, you'll need to add
+
+[source,ruby]
+----
+# encoding: UTF-8
+----
+
+as the first (or second) line of any file that uses Persistent-💎. As an alternative, you can also <<usage,use the `dmnd` syntax>>.
+
+This setting is the default from Ruby 2.0 on, so users of later versions do not need to worry about this small detail.
+
+== Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.
+
+To open a console with the gem loaded, run `bundle console`.
+
+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 https://rubygems.org[rubygems.org].
+
+== Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ivoanjo/persistent-dmnd.
+
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the http://contributor-covenant.org[Contributor Covenant] code of conduct.
+
+Maintained with 💎❤️ by https://github.com/ivoanjo/[Ivo Anjo].
+
+== Thanks
+
+Thanks to these amazing people for their contributions!
+
+* João Fernandes (https://github.com/jcmfernandes[@jcmfernandes])
+
+== License
+
+The gem is available as open source under the terms of the https://opensource.org/licenses/MIT[MIT License].
+
+== Code of Conduct
+
+Everyone interacting in the Persistent-💎 project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the https://github.com/ivoanjo/persistent-dmnd/blob/master/CODE_OF_CONDUCT.adoc[code of conduct].
+
+== Interesting links
+
+Interested in immutable/persistent data structures? Here are some interesting resources for your exploration:
+
+* https://github.com/hamstergem/hamster[hamster gem]
+* https://github.com/immutable-ruby/immutable-ruby[immmutable-ruby gem]
+* https://github.com/ivoanjo/persistent-dmnd/issues[Your suggestion here]