registry 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 85568ec14b863810f3a55309ba34bb90e5f8db07dbf47992f960dd2f6afc54af
+  data.tar.gz: 6a119eff0fc0f2d0bec47045c28aeeeb0f4035e288c0fdc787874b40300b58fc
+SHA512:
+  metadata.gz: 2b8454fe659ee8636ff65a343ec13fd82eab74d68c6e2ce4811536b1397df6897edb307acfe8287f560f212f87cc826b5929d36a88babdec214b6687b12580fd
+  data.tar.gz: 286388bd07a40b74e67371dd422aed24730b888e0fff56120b55c47e908fc35df2d6dcf4d3053b762cd684104f9e24a5da6e6ff64eb78fbe4654a1d3e389fb9d

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Dale Stevens
+
+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,58 @@
+[![Version      ](https://img.shields.io/gem/v/registry.svg)](https://rubygems.org/gems/registry)
+[![Build Status ](https://travis-ci.org/TwilightCoders/registry.svg)](https://travis-ci.org/TwilightCoders/registry)
+[![Code Climate ](https://api.codeclimate.com/v1/badges/a18ae809af878357acfa/maintainability)](https://codeclimate.com/github/TwilightCoders/registry/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/a18ae809af878357acfa/test_coverage)](https://codeclimate.com/github/TwilightCoders/registry/test_coverage)
+[![Dependencies ](https://gemnasium.com/badges/github.com/TwilightCoders/registry.svg)](https://gemnasium.com/github.com/TwilightCoders/registry)
+
+# Registry
+
+Provides a data structure for collecting homogeneous objects and indexing them for quick lookup.
+
+## Requirements
+Ruby 2.3+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'registry'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install registry
+
+## Usage
+
+```ruby
+  Person = Struct.new(:id, :name, :email)
+
+  registry = Registry.new([
+    Person.new(1, 'Dale', 'jason@twilightcoders.net'),
+    Person.new(2, 'Dale', 'dale@twilightcoders.net')
+  ])
+
+  registry.index(:name)
+
+  d = registry[:name, 'Dale'].first
+  d.name = "Jason"
+
+  registry.find(:name, 'Jason')
+```
+
+## Development
+
+After checking out the repo, run `bundle` to install dependencies. Then, run `bundle exec rspec` to run the tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/TwilightCoders/registry. 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/lib/registry.rb

@@ -0,0 +1,141 @@
+class Registry < Set
+
+  MoreThanOneRecordFound = Class.new(StandardError)
+
+  VERSION = "0.0.1"
+
+  DEFAULT_INDEX = :object_id
+
+  def initialize(*args, indexes: [])
+    @indexed = {}
+    super(*args)
+    reindex!(indexes)
+  end
+
+  def inspect
+    to_a.inspect
+  end
+
+  def to_h
+    @indexed
+  end
+
+  def indexes
+    @indexed.keys - [:object_id]
+  end
+
+  def delete(item)
+    @indexed.each do |idx, store|
+      ignore_setter(item, idx) if include?(item)
+      begin
+        idx_value = item.send(idx)
+        (store[idx_value] ||= Set.new).delete(item)
+        store.delete(idx_value) if store[idx_value].empty?
+      rescue NoMethodError => e
+        raise "#{item.name} cannot be added because indexable attribute (#{idx}) is missing."
+      end
+    end
+    super(item)
+  end
+
+  def add(item)
+    @indexed.each do |idx, store|
+      watch_setter(item, idx) unless include?(item)
+      begin
+        idx_value = item.send(idx)
+        (store[idx_value] ||= Set.new) << (item)
+      rescue NoMethodError => e
+        raise "#{item.name} cannot be added because indexable attribute (#{idx}) is missing."
+      end
+    end
+    super(item)
+  end
+  alias << add
+
+  def find!(search_criteria)
+    _find(search_criteria) { raise MoreThanOneRecordFound, "There were more than 1 records found" }
+  end
+
+  def find(search_criteria)
+    _find(search_criteria) { warn "There were more than 1 records found" }
+  end
+
+  def where(search_criteria)
+    sets = search_criteria.inject([]) do |sets, (idx, value)|
+      raise "No '#{idx}' index! Add it with '.index(:#{idx})'" unless @indexed.include?(idx)
+      sets << (@indexed.dig(idx, value) || Set.new)
+    end
+
+    subset_records = sets.reduce(sets.first, &:&)
+    subset_registry = Registry.new(subset_records, indexes: indexes)
+    subset_registry
+  end
+
+  def index(*indexes)
+    indexes.each do |idx|
+      warn "Index #{idx} already exists!" and next if @indexed.key?(idx)
+      each { |item| watch_setter(item, idx) }
+      indexed_records = group_by { |a| a.send(idx) }
+      indexed_sets = Hash[indexed_records.keys.zip(indexed_records.values.map { |e| Set.new(e) })]
+      @indexed[idx] = indexed_sets
+    end
+  end
+
+  def reindex!(indexes = [])
+    @indexed = {}
+    index(*([DEFAULT_INDEX] | indexes))
+  end
+
+  protected
+
+  def reindex(idx, item, old_value, new_value)
+    if (new_value != old_value)
+      @indexed[idx][old_value].delete item
+      (@indexed[idx][new_value] ||= Set.new).add item
+    end
+  end
+
+  private
+
+  def _find(search_criteria)
+    results = where(search_criteria)
+    yield if block_given? && results.count > 1
+    results.first
+  end
+
+  def watch_setter(item, idx)
+    return if item.frozen?
+    __registry__ = self
+    item.public_methods.select { |m| m.match(/^#{idx}=$/) }.each do |original_method|
+      watched_method = "__watched_#{original_method}".to_sym
+      renamed_method = "__unwatched_#{original_method}".to_sym
+      next if item.methods.include?(watched_method)
+
+      item.singleton_class.class_eval do
+        define_method(watched_method) do |*args|
+          old_value = item.send(idx)
+          send(renamed_method, *args).tap do |new_value|
+            __registry__.send(:reindex, idx, item, old_value, new_value)
+          end
+        end
+        alias_method renamed_method, original_method
+        alias_method original_method, watched_method
+      end
+    end
+  end
+
+  def ignore_setter(item, idx)
+    return if item.frozen?
+    item.public_methods.select { |m| m.match(/^#{idx}=$/) }.each do |original_method|
+      watched_method = "__watched_#{original_method}".to_sym
+      renamed_method = "__unwatched_#{original_method}".to_sym
+      next unless item.methods.include?(watched_method)
+      item.singleton_class.class_eval do
+        alias_method original_method, renamed_method
+        remove_method(watched_method)
+        remove_method(renamed_method)
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: registry
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dale Stevens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- dale@twilightcoders.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/registry.rb
+homepage: https://github.com/TwilightCoders/registry.
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- spec
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Data structure for quick item lookup via indexes.
+test_files: []