yml_record 0.1.2 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc9a3a6378dcf9c0065cd690c970165e47b0366109bf3f5630ccc7a3edfa6589
-  data.tar.gz: 4e5f4eee77f815ce2d35e44d832dbe3fa73509650da6d0001d72d663ca58ade6
+  metadata.gz: a720c25b1835ff9e469ebe1f5d5f962d22d19f6ddfbe08bcf0f429d9634031dc
+  data.tar.gz: 29f1ebd2b3efa494e1961baba348438ef8e5616b255ae5bf5b033de2229f4a5f
 SHA512:
-  metadata.gz: ab80c24471394a090dd7d899ce6322a99ac0176ce8925ccab7cd5c82a3b0f1e3c7783b91fa9c77476e50b61183e8e509bfdb7c9363d149971a04832bbb7d3398
-  data.tar.gz: 21b4426dbceec8a10fa1de4b4b9d5e26a80b9692990ba0985ec46d4df70ff3f7a7fb14d1317e88fcb0c53e0fe709086827cb1f9ab47e1e235546b4f2287bb82c
+  metadata.gz: abef6d9f6097fadbb11dfb6342fcfab8f41516d09290a27bd61bde14b0f9c7b0d9c6c57d30d08f19145cd34334f70db19610832b2701b4ac717c547c7286dac6
+  data.tar.gz: 3245311e591e91bde4efe5d507d24df2938377df86d42b7111d6a87da7488f6eda932b7fcb1b053e1e71c89934a4845542e531c5b291bfbda57bd036664017c0

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+.byebug_history

data/Gemfile

@@ -5,3 +5,4 @@ gemspec
 
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
+gem "activesupport", '~> 5.0'

data/Gemfile.lock

@@ -1,12 +1,21 @@
 PATH
   remote: .
   specs:
-    yml_record (0.1.1)
+    yml_record (0.1.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (5.2.8)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.1.10)
     diff-lcs (1.4.4)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.15.0)
     rake (12.3.3)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -21,14 +30,18 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activesupport (~> 5.0)
   rake (~> 12.0)
   rspec (~> 3.0)
   yml_record!
 
 BUNDLED WITH
-   2.1.2
+   2.1.4

data/README.md

@@ -29,7 +29,7 @@ Create an ApplicationYmlRecord model that inherits from YmlRecord::Base
 Create a model that will be backed by a yml data file and inherit from ApplicationYmlRecord.
 ```
   # app/models/example_model.rb
-  class ExampleModel < YamlRecord::Base; end
+  class ExampleModel < ApplicationYmlRecord
 ```
 
 Add a yml file (named the same as your model) to the `config/data/` folder
@@ -51,8 +51,104 @@ ExampleModel.find(1) #=> first instance of ExampleModel
 etc
 ```
 
+The automatic folder location for the yml files is `config/data/` but this can be manually overwritten
+The automatic file name for each model is the demodulized snakecase class name (e.g `App::ExampleClass` => `example_class.yml`)
+
+This automatic functionality can be overwritten when needed
+```
+  # to overwrite individual class's data filename to `bar.yml`
+  class Foo < ApplicationYmlRecord
+    self.filename = 'bar'
+  end
+
+  # to overwrite data folder location
+  class ApplicationYmlRecord < YamlRecord::Base
+    self.filepath = 'another/folder'
+  end
+```
+will look for data in `another/folder/bar/yml`
+
 See below for specific functionality implementations.
+The implementation examples assume the following setup
+```
+# example.yaml
+- id: 1
+  old: true
+  colour: :green
+- id: 2
+  colour: :red
+  old: true
+- id: 3
+  colour: :red
+  old: false
+
+class Example < YamlRecord::Base
+end
+```
 
+### Class methods
+#### Scopes
+Scopes will return a chainable relation with instances that match the attributes similar to active record relations
+```
+Example.where(old: true).where(colour: :red) #=> [<Example id: 1 />]
+is the same as 
+Example.where(old: true, colour: :red)
+```
+
+### Relating to YamlRecord classes
+Other classes can relate to yaml record classes using an active record style integration
+#### Has Many
+When storing primary keys of yaml records on another class, the belongs_to method can be used to create a parent like relationship.
+If the other class is dynamic (e.g: backed by a database) then the relationship can be set to dynamic (default).
+Otherwise (e.g: that class is also a yaml record) the relationship can be set to being not dynamic.
+```
+class Child
+  attr_accessor :example_id
+
+  YmlRecord.relationships.belongs_to self, :example
+end
+```
+This will add `Child#example` and `Child.example=(other_example)` instance methods.  
+
+The following will mark this relationship as static (not dynamic), which will not create the setter method (`Child.example=(other_example)`)
+```
+YmlRecord.relationships.belongs_to self, :example, dynamic: false
+```
+
+The following keys can all be manually set in the same way as with active record belongs to:  
+- foreign_key
+- primary_key
+- class_name
+
+If using active record to relate to yaml records, the following can be added to the application record to streamline implementation
+
+```
+class Car < ApplicationYmlRecord; end
+
+class ApplicationRecord < ActiveRecord::Base
+  def self.belongs_to(name, scope = nil, yml_relationship: false, **opts, &block)
+    return super(name, scope, **opts, &block)
+
+    YmlRecord.relationships.belongs_to self, name, scope, **opts, &block
+  end
+end
+
+# has db column of car_id (of type corresponding to car primary key)
+class Driver < ApplicationRecord
+  belongs_to :car, yml_relationship: true
+end
+```
+
+### Instance methods
+#### Boolean methods
+
+When an attribute is a boolean a boolean instance method is automatically created.
+```
+Example.find(1).old? #=> true
+Example.find(2).old? #=> false
+```
+
+### TODO documentation
 TODO: document implementation of custom filename  
 TODO: document implementation of custom identifier  
 TODO: document implementation of scope  
@@ -61,12 +157,10 @@ TODO: document implementation of enum
 ## Future implementations
 TODO: document
 
-- [ ] default boolean methods. Currently need to specifically set up boolean methods.  
 - [ ] setting data folder in initializer for gem
 - [ ] allow setting of specific data for specific deployments
 
 
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/yml_record/attributes.rb

@@ -1,6 +1,24 @@
+require 'yml_record/helpers/delegate_missing_to.rb'
 require 'ostruct'
 
 module YmlRecord
   # class to hold attributes, just hold and return for now
-  class Attributes < OpenStruct; end
+  class Attributes
+    extend DelegateMissingTo
+    delegate_missing_to :store
+
+    def initialize(**opts)
+      new_opts = opts.each_with_object({}) do |(key, value), acc|
+        if [true, false].include?(value) && !key.to_s.end_with?('?')
+          acc["#{key}?"] = value
+        end
+        acc[key] = value
+      end
+      @store = OpenStruct.new(**new_opts)
+    end
+
+    private
+
+    attr_reader :store
+  end
 end

data/lib/yml_record/base.rb

@@ -29,9 +29,7 @@ module YmlRecord
       protected
 
       def boolean_columns(*keys)
-        keys.each do |key|
-          define_method("#{key}?") { send(key) }
-        end
+        raise NotImplementedError, 'this method is no longer necessary, data with a boolean value automatically generates a `?` getter'
       end
 
       private

data/lib/yml_record/builders/data_loader.rb

@@ -4,7 +4,7 @@ module YmlRecord
       protected
 
       def data
-        @data ||= YAML.load_file(filepath)
+        @data ||= YAML.load_file(filelocation)
       end
 
       private
@@ -16,7 +16,11 @@ module YmlRecord
       end
 
       def filepath
-        @filepath ||= "config/data/#{filename}.yml"
+        @filepath ||= 'config/data'
+      end
+
+      def filelocation
+        @filelocation ||= "#{filepath}/#{filename}.yml"
       end
     end
   end

data/lib/yml_record/relationship_builders/belongs_to.rb

@@ -0,0 +1,39 @@
+require 'active_support/core_ext/string'
+
+module YmlRecord
+  module RelationshipBuilders
+    class BelongsTo
+      def self.build(model, name, scope = nil, **options, &_block)
+        new(model, name, scope, **options).build
+      end
+
+      def initialize(model, name, scope, dynamic: true, **options)
+        @model = model
+        @name = name
+        raise(NotImplementedError, 'yml record belongs to with scope is not yet implemented') if !!scope
+        @dynamic = dynamic
+        @options = options
+      end
+
+      def build
+        klass = (options.fetch(:class_name, nil) || name.to_s.camelize).constantize
+        klass_primary_key = options.fetch(:primay_key, klass.primary_key)
+        foreign_key = options.fetch(:foreign_key, "#{name}_#{klass_primary_key}")
+
+        model.define_method name do
+          klass.find_by(klass_primary_key => send(foreign_key))
+        end
+
+        if dynamic
+          model.define_method "#{name}=" do |instance|
+            self.send("#{foreign_key}=", instance.send(klass_primary_key))
+          end
+        end
+      end
+
+      private
+
+      attr_reader :model, :name, :dynamic, :options
+    end
+  end
+end

data/lib/yml_record/relationship_builders.rb

@@ -0,0 +1,9 @@
+require 'yml_record/relationship_builders/belongs_to.rb'
+
+module YmlRecord
+  module RelationshipBuilders
+    def self.belongs_to(*args, **opts, &block)
+      BelongsTo.build(*args, **opts, &block)
+    end
+  end
+end

data/lib/yml_record/version.rb

@@ -1,3 +1,3 @@
 module YmlRecord
-  VERSION = "0.1.2"
+  VERSION = "0.1.5"
 end

data/lib/yml_record.rb

@@ -1,6 +1,11 @@
 require 'yml_record/base'
 require "yml_record/version"
+require 'yml_record/relationship_builders'
 
 module YmlRecord
   class Error < StandardError; end
+
+  def self.relationships
+    YmlRecord::RelationshipBuilders
+  end
 end

data/yml_record.gemspec

@@ -11,12 +11,11 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://rubygems.org/gems/yml_record"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.metadata["source_code_uri"] = "https://github.com/tjbarker/yml_record#readme"
 
-  # TODO: do later cause I CBF now
   # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
 
   # spec.metadata["homepage_uri"] = spec.homepage
-  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
   # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
 
   # Specify which files should be added to the gem when it is released.
@@ -24,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
+
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yml_record
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.5
 platform: ruby
 authors:
 - Tom Barker
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-19 00:00:00.000000000 Z
+date: 2022-07-15 00:00:00.000000000 Z
 dependencies: []
 description: A gem for presenting ActiveRecord like interface for yml backed models
 email:
@@ -38,12 +38,15 @@ files:
 - lib/yml_record/builders/scope.rb
 - lib/yml_record/helpers/delegate_missing_to.rb
 - lib/yml_record/relation.rb
+- lib/yml_record/relationship_builders.rb
+- lib/yml_record/relationship_builders/belongs_to.rb
 - lib/yml_record/version.rb
 - yml_record.gemspec
 homepage: https://rubygems.org/gems/yml_record
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/tjbarker/yml_record#readme
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -59,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: A gem for presenting ActiveRecord like interface for yml backed models