yml_record 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fca9dae5bf10baf7aa88ebc253304b24b91f29b144fc0797883cb257436d694
-  data.tar.gz: 7c0104c4d01ae2f4ec5c00b0c58fd9cdca6d686f925600cf494e4a540a08b2e4
+  metadata.gz: bc3ea52217e192ab11305116a1c9c4822209a106c8412cb59f4e17e399da6698
+  data.tar.gz: 7beec8530b22a8a6545c07dc4f443d536d95f8b0f0a85a92fd9c75ea9ee8af24
 SHA512:
-  metadata.gz: '097bd7048303e136a95d7131c16c993f4a64dec847dca3a1a85fc8b30ab4a754f607758920905f4c94f3a045d7c70c881ade6b734076a6c31cc1600dd162c88b'
-  data.tar.gz: b437e63384dd038a4b8a760b5a59189a9eec1ae61affc809dd6b6a95c2477ff90b8dc5995d9621110ea4f4f4b490ebb6f8cf3fd12ad6fd4c82556e619cc6f046
+  metadata.gz: 18e31398c0bccae297cc956c07b2bf9494beab4054f0f423eda53d1c729725407bbde37c0bdfc61342e4fbc565a6b732fac9461499460815449d3014bda5b750
+  data.tar.gz: 14af825e0bec0db3e3923b300adf7467acad081c2a6fce55bc2d10a6cb5c7e42fb683d227eadf49d8bcc6edef7a68173821cae10a5bbe7c201ee446166537bd7

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.2)
+    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,11 +30,15 @@ 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!

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/builders/data_loader.rb

@@ -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.3"
+  VERSION = "0.1.4"
 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

@@ -13,7 +13,6 @@ Gem::Specification.new do |spec|
   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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yml_record
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Tom Barker
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-04 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,6 +38,8 @@ 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