poros 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb33cb3edeb46a15e44bb915e71420a9c92ed99234ee52ab3d083b2e963b9807
-  data.tar.gz: 503c54369c8579a4a0d7fa41a2ae5bdb3cbdd59e8b4a4c999ad531d104858825
+  metadata.gz: 6dc1a45e91216abe73208b6c54926ad645e00217ac26c1ee829afc4b75bd279a
+  data.tar.gz: b0eae29db2cba9dfe71dc4d830bbba43c41ff2ea8cb6a6d4c89328f4ce2d450b
 SHA512:
-  metadata.gz: 02f0e7d5fbb462f9e4e29595c8d2e22fc775410b4b7782e1db43c787f078c4b8b07c61ebb2b57c4ea35215a4f1074faadc1bdbd297be29dd409f493c5a5bf31b
-  data.tar.gz: 95c434c7a70309d7bf2181dfbee83c9e0856969bff04051353b8b06c1c0391768e7802e3fe37457b712893b7950af959f75e7f0a75b1cfb866ccfc92fb256752
+  metadata.gz: c26f6f28c9324df4cd0be12b514ee967486e3a80a6fa051b0682099b77fdaa50ae77720aa698af07dcd4c789593ddddd32e0d9cb0d926e8cd1314fc1a3a57834
+  data.tar.gz: 3c04c87297694078d97ec8b29c98d440ce0e5c0274791899bab06ac859d5638b671b1b3b94d33b0177471367a2ec76c74fa234fb7cc2fbac3327fcd6df38c293

data/README.md

@@ -52,9 +52,9 @@ many_widgets = Widget.where(order: 1, name: /regex/)
 attributes defined in `poro_attr`. In the future I may define this function for
 you but for right now I'm not sure I want to go that direction.
 
-`poro_attrs :blah` will define a getter and setter for `:blah` and also be persisted when you run `#save`
+`poro_attr :blah` will define a getter and setter for `:blah` and also be persisted when you run `#save`
 
-`poro_indexes :blah` will create indexes on these columns, this will greatly
+`poro_index :blah` will create indexes on these columns, this will greatly
 speed up searching but if your index gets really big the initial load of a
 model will take quite a long time.
 
@@ -62,8 +62,7 @@ model will take quite a long time.
 save to the default of `./db/#{self}`. If you do re-define it you _must_
 seperate each model into it's own folder or it will have _lots_ of issues.
 
-`.where` acts a bit like ActiveRecord but it's not currently chainable (I plan
-to do that in the future though) and takes exact matches, regexs, arrays, or
+`.where` acts a bit like ActiveRecord and it takes exact matches, regexs, arrays, or
 lambdas in any combination.
 
 ```ruby
@@ -72,15 +71,52 @@ Widget.where(name: 'sprocket')
 Widget.where(name: /spr.*cket/)
 Widget.where(order: -> value { value > 3 })
 Widget.where(order: [1, 5, 8], active: true)
+Widget.where(order: 1).where(name: 'cog')
 
 # Invalid examples
 Widget.where(name: 'sprocket', name: 'cog') # can't check same value twice, use arrays
-Widget.where(order: 1).where(name: 'cog')   # can't chain wheres
 ```
 
-
 `.find` takes the `#uuid` which is generated by Poros and returns the single record.
 
+A basic usage of relations would be something like:
+
+```ruby
+class Author
+  include Poros
+
+  poro_attr :name
+
+  has_many :books
+
+  def initialize(name: '')
+    @name = name
+  end
+end
+
+class Book
+  include Poros
+
+  poro_attr :title, :author_uuid
+
+  belongs_to :author
+
+  def initialize(title: '', author: nil, author_uuid: nil)
+    @title = title
+    @author_uuid = author_uuid if author_uuid
+    self.author = author if author
+  end
+end
+
+audrey_niffenegger = Author.new(name: 'Audrey Niffenegger').save
+john_steinbeck = Author.new(name: 'John Steinbeck').save
+book_1 = Book.new(title: 'The Grapes of Wrath', author_uuid: john_steinbeck.uuid).save
+book_2 = Book.new(title: 'The Time Traveler\'s Wife', author_uuid: audrey_niffenegger.uuid).save
+book_3 = Book.new(title: 'Of Mice and Men', author_uuid: john_steinbeck.uuid).save
+```
+
+And then you'll be able to do things like `author_2.books.where(name: /wrath/)` or `book_2.author`
+
 ## Development
 
 After checking out the repo, run `bundle install` to install dependencies. Then, run

data/lib/poros/class_methods.rb

@@ -57,54 +57,7 @@ module Poros
     end
 
     def where(query)
-      indexed, table_scan = query.partition { |index, key| poro_indexes.include?(index) }
-
-      indexed_results = indexed.map { |key, value|
-        case value
-        when Regexp
-          index_data[key].keys.flat_map { |value_name|
-            index_data[key][value_name] if value =~ value_name
-          }.compact
-        when Array
-          value.flat_map { |value_name| index_data[key][value_name] }
-        when Proc
-          index_data[key].keys.flat_map { |value_name|
-            index_data[key][value_name] if value.call(value_name)
-          }.compact
-        else
-          index_data[key].has_key?(value) ?
-            index_data[key][value] : []
-        end
-      }.inject(:&)
-
-      if table_scan.size > 0
-        scanned_results = Dir.glob(File.join(data_directory, '*.yml')).map { |file|
-          next if file == index_file
-          data = YAML.load(File.read(file))
-          data[:uuid] if table_scan.all? { |key, value|
-            case value
-            when Regexp
-              value =~ data[key]
-            when Array
-              value.include?(data[key])
-            when Proc
-              value.call(data[key])
-            else
-              data[key] == value
-            end
-          }
-        }.compact
-      end
-
-      if indexed.size > 0 && table_scan.size > 0
-        results = indexed_results & scanned_results
-      elsif indexed.size > 0
-        results = indexed_results
-      else
-        results = scanned_results
-      end
-
-      results.map { |uuid| find(uuid) }
+      Poros::Query.new(self).where(query)
     end
 
     def index_data

data/lib/poros/instance_methods.rb

@@ -23,5 +23,9 @@ module Poros
       self.class.update_index(self)
       self
     end
+
+    def ==(other)
+      uuid == other.uuid
+    end
   end
 end

data/lib/poros/query.rb

@@ -0,0 +1,71 @@
+module Poros
+  class Query
+    include Enumerable
+    attr_accessor :object, :queries
+
+    def initialize(object)
+      @object = object
+      @queries = {}
+    end
+
+    def where(query)
+      @queries.merge!(query)
+      self
+    end
+
+    def each(&block)
+      results.each { |result| block.call(result) }
+    end
+
+    def results
+      indexed, table_scan = @queries.partition { |index, key| @object.poro_indexes.include?(index) }
+
+      indexed_results = indexed.map { |key, value|
+        case value
+        when Regexp
+          @object.index_data[key].keys.flat_map { |value_name|
+            @object.index_data[key][value_name] if value =~ value_name
+          }.compact
+        when Array
+          value.flat_map { |value_name| @object.index_data[key][value_name] }
+        when Proc
+          @object.index_data[key].keys.flat_map { |value_name|
+            @object.index_data[key][value_name] if value.call(value_name)
+          }.compact
+        else
+          @object.index_data[key].has_key?(value) ?
+            @object.index_data[key][value] : []
+        end
+      }.inject(:&)
+
+      if table_scan.size > 0
+        scanned_results = Dir.glob(File.join(@object.data_directory, '*.yml')).map { |file|
+          next if file == @object.index_file
+          data = YAML.load(File.read(file))
+          data[:uuid] if table_scan.all? { |key, value|
+            case value
+            when Regexp
+              value =~ data[key]
+            when Array
+              value.include?(data[key])
+            when Proc
+              value.call(data[key])
+            else
+              data[key] == value
+            end
+          }
+        }.compact
+      end
+
+      if indexed.size > 0 && table_scan.size > 0
+        results = indexed_results & scanned_results
+      elsif indexed.size > 0
+        results = indexed_results
+      else
+        results = scanned_results
+      end
+
+      results.map { |uuid| @object.find(uuid) }
+    end
+  end
+end

data/lib/poros/relations.rb

@@ -0,0 +1,55 @@
+module Poros
+  module Relations
+    def has_many(key, class_name: nil, foreign_key: nil, primary_key: :uuid)
+
+      define_method key do
+        foreign_key = (foreign_key || self.class.to_s.downcase + '_uuid').to_sym
+        object = constantize(singularize(class_name || key))
+        primary_value = self.send(primary_key)
+
+        object.where(foreign_key => primary_value)
+      end
+    end
+
+    def belongs_to(key, class_name: nil, foreign_key: nil, primary_key: :uuid)
+      define_method key do
+        object = constantize(class_name || key)
+        foreign_method = (foreign_key || (key.to_s + '_uuid')).to_sym
+        primary_attr = primary_key || (key.to_s + '_uuid')
+
+        object.where(primary_attr => self.send(foreign_method)).first
+      end
+
+      define_method key.to_s + '=' do |value|
+        foreign_attr = foreign_key || (key.to_s + '_uuid=')
+        primary_method = primary_key || (key.to_s + '_uuid')
+
+        self.send(foreign_attr, value.send(primary_method))
+      end
+    end
+
+    private
+
+    def singularize(word)
+      # I don't want to depend on rails or another gem so I'm doing something
+      # incredibly basic that'll work 90+% of the time (for English anyways).
+      case word.to_s
+      when /ies$/
+        word.to_s.chomp('ies') + 'y'
+      when /s$/
+        word.to_s.chomp('s')
+      else
+        word.to_s
+      end
+    end
+
+    def constantize(word)
+      object_name = word
+      if word.downcase == word
+        object_name = word.to_s.split('_').map(&:capitalize).join
+      end
+
+      Object.const_get(object_name)
+    end
+  end
+end

data/lib/poros/version.rb

@@ -1,3 +1,3 @@
 module Poros
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

data/lib/poros.rb

@@ -1,16 +1,20 @@
 require 'yaml'
 require 'securerandom'
 
+require 'poros/query'
 require 'poros/instance_methods'
 require 'poros/class_methods'
+require 'poros/relations'
 
 module Poros
   include Poros::InstanceMethods
   include Poros::ClassMethods
+  include Poros::Relations
 
   def self.included(base)
     base.class_eval do
       extend ClassMethods
+      extend Relations
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: poros
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Sean Ross Earle
@@ -69,6 +69,8 @@ files:
 - lib/poros/class_methods.rb
 - lib/poros/info.rb
 - lib/poros/instance_methods.rb
+- lib/poros/query.rb
+- lib/poros/relations.rb
 - lib/poros/version.rb
 - poros.gemspec
 homepage: https://github.com/HellRok/YAMLCache