yml_record 0.0.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '005397e7310eb09049d530abdaf0adb2f29c5a939c438bfd33d225cd40cd26df'
-  data.tar.gz: bca02908ba64cd0e2a61b1d7f375e9cce1e7e68b798064b91bcbc63f9ebf5726
+  metadata.gz: bc3ea52217e192ab11305116a1c9c4822209a106c8412cb59f4e17e399da6698
+  data.tar.gz: 7beec8530b22a8a6545c07dc4f443d536d95f8b0f0a85a92fd9c75ea9ee8af24
 SHA512:
-  metadata.gz: 762b13835669bc08e09249648cb89259f24477fc4250a0c3adac452f70db0ade5ff6f023b3b1775e22935590676789801dbb85f25365bbc1c28fb9a1c42237ac
-  data.tar.gz: 9147868feeb335e7ac18ba44e6422a7a46fed2f239beeee57f01d6fc3df9603304ed5466a8269972d7f7c9c4a9e5ae15b31123e5100b45c732f4ef1533eff0c4
+  metadata.gz: 18e31398c0bccae297cc956c07b2bf9494beab4054f0f423eda53d1c729725407bbde37c0bdfc61342e4fbc565a6b732fac9461499460815449d3014bda5b750
+  data.tar.gz: 14af825e0bec0db3e3923b300adf7467acad081c2a6fce55bc2d10a6cb5c7e42fb683d227eadf49d8bcc6edef7a68173821cae10a5bbe7c201ee446166537bd7

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.byebug_history

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# 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 tom@sherpa.net.au. 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 [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in yml_record.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "activesupport", '~> 5.0'

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    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)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      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.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Tom Barker
+
+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,181 @@
+# YmlRecord
+
+YmlRecord is a gem to allow easy instantiating of classes from a yml file and exposing an ActiveRecord-esque api.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yml_record'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install yml_record
+
+## Usage
+
+Create an ApplicationYmlRecord model that inherits from YmlRecord::Base
+```
+  # app/models/application_yml_record.rb
+  class ApplicationYmlRecord < YmlRecord::Base; end
+```
+
+Create a model that will be backed by a yml data file and inherit from ApplicationYmlRecord.
+```
+  # app/models/example_model.rb
+  class ExampleModel < ApplicationYmlRecord
+```
+
+Add a yml file (named the same as your model) to the `config/data/` folder
+```
+  # config/data/example_model.yml
+  - id: 1
+    name: one
+  - id: 2
+    name: two
+```
+
+This model can now be used as if it were backed by activerecord and a database table.
+N.B: this functionality does not include create or update actions.
+
+```
+ExampleModel.all #=> relation of 2 instances
+ExampleModel.where(name: 'one') #=> relation of 1 (first) instance
+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  
+TODO: document implementation of enum  
+
+## Future implementations
+TODO: document
+
+- [ ] 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.
+
+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 [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tjbarker/yml_record. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/tjbarker/yml_record/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the YmlRecord project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/tjbarker/yml_record/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "yml_record"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/yml_record/attributes.rb

@@ -0,0 +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
+    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

@@ -0,0 +1,53 @@
+require 'yaml'
+require 'yml_record/helpers/delegate_missing_to.rb'
+require 'yml_record/relation.rb'
+require 'yml_record/attributes.rb'
+require 'yml_record/builders/enum.rb'
+require 'yml_record/builders/scope.rb'
+require 'yml_record/builders/data_loader.rb'
+require 'yml_record/builders/all.rb'
+require 'yml_record/builders/has_attributes.rb'
+
+module YmlRecord
+  class Base
+    extend DelegateMissingTo
+
+    include Builders::HasAttributes
+
+    class << self
+      extend DelegateMissingTo
+
+      include Builders::DataLoader
+      include Builders::All # Includes a delegate_missing_to_all
+      include Builders::Enum
+      include Builders::Scope
+
+      def primary_key
+        @primary_key ||= 'id'
+      end
+
+      protected
+
+      def boolean_columns(*keys)
+        raise NotImplementedError, 'this method is no longer necessary, data with a boolean value automatically generates a `?` getter'
+      end
+
+      private
+
+      attr_writer :primary_key
+
+      def relation_klass
+        @relation_klass ||= const_set('Relation', Class.new(Relation))
+      end
+    end
+
+    def ==(other)
+      other.send(:__identifier) == __identifier
+    end
+
+    # for inheritor to overwrite if other means of equating is necessary
+    def __identifier
+      respond_to?(:id) ? "id-#{id}" : "hash-#{hash}"
+    end
+  end
+end

data/lib/yml_record/builders/all.rb

@@ -0,0 +1,15 @@
+require 'yml_record/helpers/delegate_missing_to.rb'
+
+module YmlRecord
+  module Builders 
+    module All
+      extend DelegateMissingTo
+
+      def all
+        @all ||= relation_klass.new(data.map { |op| new(**op) })
+      end
+
+      delegate_missing_to :all
+    end
+  end
+end

data/lib/yml_record/builders/data_loader.rb

@@ -0,0 +1,27 @@
+module YmlRecord
+  module Builders
+    module DataLoader
+      protected
+
+      def data
+        @data ||= YAML.load_file(filepath)
+      end
+
+      private
+
+      attr_writer :filename, :filepath, :primary_key
+
+      def filename
+        @filename ||= name.demodulize.snakecase
+      end
+
+      def filepath
+        @filepath ||= 'config/data'
+      end
+
+      def filelocation
+        @filelocation ||= "#{filepath}/#{filename}.yml"
+      end
+    end
+  end
+end

data/lib/yml_record/builders/enum.rb

@@ -0,0 +1,40 @@
+module YmlRecord
+  module Pluralize
+    #TODO: implement this properly
+    def self.call(string)
+      "#{string}s"
+    end
+  end
+
+  module Builders
+    module Enum
+
+      # will define:
+      # - the list of keys on class
+      # - for each enum value a check method, e.g: Class.new.key? => Boolean
+      # - for each enum value a class scope, e.g: Class.key => relation
+      # singular true => Class.key will return first instance with value
+      # singular false => Class.key will return a relation of instances with value
+      def enum(key, singular: false)
+        key = key.to_s
+        plural = Pluralize.call(key)
+
+        define_singleton_method plural do
+          all.inject([]) do |acc, d|
+            acc << d.send(key)
+          end.uniq.compact
+        end
+
+        send(plural).each do |value|
+          define_method "#{value}?" do
+            send(key) == value
+          end
+
+          define_singleton_method value do
+            send(singular ? :find_by : :where, key => value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yml_record/builders/has_attributes.rb

@@ -0,0 +1,19 @@
+require 'yml_record/helpers/delegate_missing_to.rb'
+
+module YmlRecord
+  module Builders 
+    module HasAttributes
+      extend DelegateMissingTo
+
+      def initialize(**data)
+        @attributes = Attributes.new(**data)
+      end
+
+      delegate_missing_to :attributes
+
+      private
+
+      attr_reader :attributes
+    end
+  end
+end

data/lib/yml_record/builders/scope.rb

@@ -0,0 +1,14 @@
+module YmlRecord
+  module Builders 
+    module Scope
+      def scope(name, body, &_block)
+        body.respond_to?(:call) || raise(ArgumentError, 'The scope body needs to be callable.')
+        block_given? && raise(NotImplementedError, 'Scopes do not handle extension.')
+
+        relation_klass.define_method name do
+          instance_exec(&body)
+        end
+      end
+    end
+  end
+end

data/lib/yml_record/helpers/delegate_missing_to.rb

@@ -0,0 +1,22 @@
+module DelegateMissingTo
+  def delegate_missing_to(relation)
+    define_method :respond_to_missing? do |name, include_private = false|
+      send(relation).respond_to?(name) || super(name, include_private)
+    end
+
+    define_method :method_missing do |method, *args, **opts, &block|
+      if send(relation).respond_to?(method)
+        send(relation).public_send(method, *args, **opts, &block)
+      else
+        begin
+          super(method, *args, **opts, &block)
+        rescue NoMethodError
+          raise
+        end
+      end
+    end
+    
+    private :respond_to_missing?
+    private :method_missing
+  end
+end

data/lib/yml_record/relation.rb

@@ -0,0 +1,46 @@
+require 'yml_record/helpers/delegate_missing_to.rb'
+
+module YmlRecord
+  class Relation
+    extend DelegateMissingTo
+    delegate_missing_to :list
+
+    def initialize(list)
+      @list = list
+    end
+
+    def where(**opts)
+      self.class.new(opts.inject(list) do |list, (key, values)|
+        list.select do |inst|
+          value_list = values.nil? ? [nil] : Array(values)
+          value_list.include?(inst.send(key))
+        end
+      end)
+    end
+
+    def find_by(**opts)
+      where(**opts).first
+    end
+
+    def order(*keys, **keys_with_direction)
+      direction_list = keys.inject(keys_with_direction) do |acc, key|
+        { key => :asc }.merge(**acc)
+      end
+
+      self.class.new(list.sort_by do |inst|
+        direction_list.map do |key, direction|
+          direction == :asc ? inst.send(key) : -inst.send(key)
+        end
+      end)
+    end
+
+    def all
+      self
+    end
+
+    private
+
+    attr_reader :list
+  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

@@ -0,0 +1,3 @@
+module YmlRecord
+  VERSION = "0.1.4"
+end

data/lib/yml_record.rb

@@ -1,5 +1,11 @@
-class YmlRecord
-  def self.testing_method
-    'This is a test'
+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

@@ -0,0 +1,30 @@
+require_relative 'lib/yml_record/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "yml_record"
+  spec.version       = YmlRecord::VERSION
+  spec.authors       = ["Tom Barker"]
+  spec.email         = ["thomasjohnbarker@gmail.com"]
+
+  spec.summary       = %q{A gem for presenting ActiveRecord like interface for yml backed models}
+  spec.description   = %q{A gem for presenting ActiveRecord like interface for yml backed models}
+  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"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  # spec.metadata["homepage_uri"] = spec.homepage
+  # 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.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  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"]
+end

metadata

@@ -1,26 +1,52 @@
 --- !ruby/object:Gem::Specification
 name: yml_record
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.4
 platform: ruby
 authors:
-- Thomas Barker
+- Tom Barker
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2021-09-10 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: thomasjohnbarker@gmail.com
+email:
+- thomasjohnbarker@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
 - lib/yml_record.rb
+- lib/yml_record/attributes.rb
+- lib/yml_record/base.rb
+- lib/yml_record/builders/all.rb
+- lib/yml_record/builders/data_loader.rb
+- lib/yml_record/builders/enum.rb
+- lib/yml_record/builders/has_attributes.rb
+- 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:
@@ -29,7 +55,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="