fixed_record 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 517a804c21cbd7ebe17493341ae42ddef70193953f5d3a40026907f470088eeb
+  data.tar.gz: 8d7f1d298b25419ef38b457b0a6284dcf6c3b385dfa20b272d98a09f3281b607
+SHA512:
+  metadata.gz: ac9c2c0ba7632aa0edf97a49f5a4e95377f99f5aa46ed28ec4de7a91560f0aa4e96e1edbbbaf203f9623711c5baaf57ce3ac4d7a99f8d55876a2435954dd091f
+  data.tar.gz: 4e76dc6a252b5e71c6932d423ab2c274bdb9d975004879d97409a421ea5baeabee15dc101cd321c754576bbef126eaa70f6017cd262d125a892d3c4735d31208

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Compiled gems
+*.gem

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.4
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in fixed_record.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    fixed_record (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  fixed_record!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/README.md

@@ -0,0 +1,103 @@
+# FixedRecord
+
+FixedRecord provides ActiveRecord-like read-only access to a set of records
+described in a YAML file.
+
+Why is this useful? Occasionally you have tabular data which hardly ever
+changes and can easily be edited by hand. Although this code could be placed in a database, it's not worth the overheads (loading a database, maintaining database code). 
+
+It's quicker and simpler to implement this as an array of objects in a YAML file. 
+
+See the Usage section below
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fixed_record'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fixed_record
+
+## Usage
+
+Create a YAML file defining an array of records like this:
+
+```yaml
+-
+    name: Risky Thinking
+    url: https://www.riskythinking.com/
+-
+    name: Krebs on Security
+    url: https://krebsonsecurity.com/
+
+```
+
+Then to load these, create a class
+
+```ruby
+require 'FixedRecord'
+
+class MyFavoriteWebsite < FixedRecord
+    data "#{Rails.root}/data/my_favorite_websites.yml"
+
+  # Return hostname of url for company
+  def hostname
+    URI.parse(url).host
+  end
+
+end
+```
+The collection can then be enumerated as required:
+
+```ruby
+MyFavoriteWebsite.each do |w| 
+    puts w.name
+    puts w.hostname
+end
+```
+Or can be accessed as an array:
+
+```ruby
+MyFavoriteWebiste.all
+```
+A count of the number of records is available:
+
+```ruby
+puts MyFavoriteWebiste.count
+```
+
+The class also includes the `Enumerable` module.
+
+Some basic sanity checks are performed on the YAML file to catch common errors:
+
+* It must define a non-empty array of records
+* All records must have the same set of attributes
+
+An `ArgumentError` exception will be thrown if any errors are detected.
+
+Additional validations can be performed by overriding the `validate_yaml` and
+`validate_item` class functions. 
+
+
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` 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 `fixed_record.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/[USERNAME]/fixed_record.

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 "fixed_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/fixed_record.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "fixed_record"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fixed_record"
+  spec.version       = FixedRecord::VERSION
+  spec.authors       = ["Mike Bell"]
+  spec.email         = ["mbell@albionresearch.com"]
+
+  spec.summary       = %q{Provide ActiveRecord like read-only access to a small dataset stored in a YAML file}
+  #spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/m-z-b/fixed_record/blob/master/README.md"
+  spec.license       = "MIT"
+
+  #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/m-z-b/fixed_record"
+  #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"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/fixed_record.rb

@@ -0,0 +1,74 @@
+
+require 'yaml'
+
+class FixedRecord
+  VERSION = "0.1.2"
+
+  # Lazy load data from given filename 
+  # creating accessors for top level attributes
+  def self.data( filename ) 
+    class_eval %Q{
+      class << self
+        include Enumerable
+      end
+
+      @@items = nil
+
+      def self.filename
+        %Q{#{filename}}
+      end
+
+      def self.all 
+        load!
+        @@items
+      end
+
+      def self.each( &block )
+        all.each(&block)
+      end
+
+      def self.count
+        all.count
+      end
+
+      def self.load!
+        if @@items.nil?
+          y = YAML.load_file( filename )
+          validate_yaml( y )
+          valid_keys = y.first.keys
+          valid_keys.each do |k|
+            define_method( k.to_sym) { @values[k] }
+          end
+
+          @@items = y.map.with_index do |values,i|
+            validate_item( valid_keys, values, i )
+            r = new
+            r.instance_variable_set( :@values, values )
+            r
+          end
+        end
+      end
+    }
+  end
+
+  # Validate the top level of the data structure returned 
+  def self.validate_yaml( y )
+    unless y.is_a?(Array) && y.length > 0
+      throw ArgumentError.new "#{filename} does not contain an array of items"
+    end
+  end
+
+  # Validate a hash of name -> value
+  def self.validate_item( keys, hash, index )
+    raise ArgumentError, "#{filename} item #{index+1} should be name value pairs" unless hash.is_a?(Hash)
+    raise ArgumentError, "#{filename} item #{index+1} has wrong number of values" if keys.count != hash.count
+    keys.each do |name|
+      unless hash.has_key? name
+        raise ArgumentError, "#{filename} item #{index+1}  is missing value for '#{name}'" 
+      end
+    end
+  end
+
+
+
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: fixed_record
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Mike Bell
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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:
+- mbell@albionresearch.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fixed_record.gemspec
+- lib/fixed_record.rb
+homepage: https://github.com/m-z-b/fixed_record/blob/master/README.md
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/m-z-b/fixed_record/blob/master/README.md
+  source_code_uri: https://github.com/m-z-b/fixed_record
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Provide ActiveRecord like read-only access to a small dataset stored in a
+  YAML file
+test_files: []