built_in_data 1.1.4 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9394bd2479dccf207f906c6ca48653287a621c5d6522306b770e556fce552d56
-  data.tar.gz: 9e1d7d9e4ef5706036452492f31bdd1061b79d8fc048c8cd891a1c68bb9f1793
+  metadata.gz: 1dcb3fbcceaeff5cb4d43a1bc0c08edb3b375324ad4797c1ffcf24923913f0cd
+  data.tar.gz: 2b2195a4b426b877bb80cfb36c51e4244e05540ed71e8cb853c9eb0175373cde
 SHA512:
-  metadata.gz: 638ce6c855a13e1254ff71a0e3fe5888d7c4c8996d70277e58ea2636f470dabde48922bca6aa60c6459487d0604329a4f8d9d49c266732c2dcd192281f49e874
-  data.tar.gz: 6d737a730d0b4a63b7393babcb4de49fdff07e0b1a556bd07d436769c97d3d8c6bf05ee9befea440798a580ad19a2f291f32f9c05529cae747b6e65ed972006a
+  metadata.gz: 8252552d62e0f142c16f51465205ff986e11f5f30d23c4af1db7d45359e36b90a32814d66d277fdb29cb982fadaee65e6a2419352a97c19c3c5b1efde5a59e8c
+  data.tar.gz: 973e5ec125c4e846c63ec464de0e3a3824491f5704d478d2dedab136ba269a4b8e0a0e00d387ceaf548c812fb75dacc631e239f44d2e431a0163e7c4db0d6638

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2012-2013 WorldWide IDEA, Inc http://www.wwidea.org
+Copyright 2012-2023 Brightways Learning https://www.brightwayslearning.org
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,58 @@
+# BuiltInData
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/02eb42a4a53414adae01/maintainability)](https://codeclimate.com/github/wwidea/built_in_data/maintainability)
+
+BuiltInData is a simple tool for loading and updating data in a Rails application.
+
+Objects are stored in the database with a **built_in_key** that is used on subsequent loads to update or remove the object. Items in the table without a **built_in_key** will not be modified or removed.
+
+BuiltInData is designed to address the data gray area between customer data and constants. It allows developers to deliver, update, and destroy data that is stored in the database.
+
+## Setup
+Add **built_in_key** to your model:
+```bash
+ruby script/rails generate migration AddBuiltInKeyToYourModel built_in_key:string:index
+rake db:migrate
+```
+
+Include **BuiltInData** in your model:
+```ruby
+class YourModel < ActiveRecord::Base
+  include BuiltInData
+end
+```
+
+## Loading Data
+There are two methods to load data
+
+- Pass as a hash to load_built_in_data!
+```ruby
+YourModel.load_built_in_data!({
+  glacier: {
+    name: 'Glacier National Park'
+  },
+  yellowstone: {
+    name: 'Yellowstone National Park'
+  }
+})
+```
+
+- Create a yaml load file in **db/built_in_data** with the name of the model (ie. national_parks.yml), and load the data with `YourModel.load_built_in_data!` without any arguments.  The yaml file can contain erb.
+```yaml
+glacier:
+  name: Glacier National Park
+  established: <%= Date.parse('1910-05-11') %>
+
+yellowstone:
+  name: Yellowstone National Park
+  established: 1872-03-01
+```
+
+## Other
+Use **built_in?** to check if an object was loaded by BuiltInData:
+```ruby
+object.built_in?
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,10 +1,5 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+# frozen_string_literal: true
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
+require "bundler/setup"
 
-task default: :test
+require "bundler/gem_tasks"

data/lib/built_in_data/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BuiltInData
-  VERSION = "1.1.4"
+  VERSION = "1.2.1"
 end

data/lib/built_in_data.rb

@@ -1,30 +1,29 @@
+# frozen_string_literal: true
+
+require "built_in_data/version"
+
 module BuiltInData
   extend ActiveSupport::Concern
 
   included do
-    # all built in data objects should have a built_in_key, model objects without a key will not be modified or removed
+    # All built in data objects should have a built_in_key, model objects without a key will not be modified or removed
     validates_uniqueness_of :built_in_key, allow_nil: true, case_sensitive: false
 
-    scope :built_in, -> { where "#{table_name}.built_in_key IS NOT NULL" }
+    scope :built_in, -> { where.not(built_in_key: nil) }
   end
 
   module ClassMethods
+    # Inserts new, updates existing, and destorys removed built_in objects
     def load_built_in_data!(hash = nil)
       objects_hash = prepare_objects_hash(hash)
-      Array.new.tap do |updated_objects|
-
-        objects_hash.each do |key, attributes|
-          updated_objects << create_or_update!(key, attributes)
-        end
+      destroy_removed_built_in_objects!(objects_hash.keys)
 
-        # destroy any built_in objects that have been removed from built_in_data_attributes
-        self.built_in.each do |object|
-          object.destroy unless objects_hash.has_key?(object.built_in_key)
-        end
+      objects_hash.map do |key, attributes|
+        create_or_update!(key, attributes)
       end
     end
 
-    # cached database id for fixture files
+    # Cached database id for fixture files
     def built_in_object_id(key)
       built_in_object_ids[key]
     end
@@ -37,20 +36,25 @@ module BuiltInData
     private
 
     def prepare_objects_hash(hash)
-      return hash.nil? ? load_yaml_data : hash.with_indifferent_access
+      hash.nil? ? load_yaml_data : hash.with_indifferent_access
     end
 
     def load_yaml_data
       # allow a standard key to be used for defaults in YAML files
       YAML.safe_load(
         read_and_erb_process_yaml_file,
-        permitted_classes:  [Date],
-        aliases:            true
-      ).except('DEFAULTS')
+        permitted_classes: [Date],
+        aliases:           true
+      ).except("DEFAULTS")
     end
 
     def read_and_erb_process_yaml_file
-      ERB.new(File.read(Rails.root.join('db', 'built_in_data', "#{table_name}.yml"))).result
+      ERB.new(Rails.root.join("db", "built_in_data", "#{table_name}.yml").read).result
+    end
+
+    # Destroys built_in objects with a built_in_key not present in built_in_keys array
+    def destroy_removed_built_in_objects!(built_in_keys)
+      built_in.where.not(built_in_key: built_in_keys).destroy_all
     end
 
     def create_or_update!(key, attributes)
@@ -60,15 +64,15 @@ module BuiltInData
       end
     end
 
-    # memoized hash of built in object ids
+    # Memoized hash of built in object ids
     def built_in_object_ids
       @built_in_object_ids ||= Hash.new do |hash, key|
-        hash[key] = where(built_in_key: key).pluck(:id).first
+        hash[key] = where(built_in_key: key).pick(:id)
       end
     end
   end
 
   def built_in?
-    !built_in_key.blank?
+    built_in_key.present?
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: built_in_data
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.2.1
 platform: ruby
 authors:
 - Aaron Baldwin
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-07 00:00:00.000000000 Z
+date: 2023-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -28,66 +28,23 @@ dependencies:
 description: BuiltInData is a simple tool for loading and updating data in a Rails
   application.
 email:
-- developers@brightwayslearning.org
+- baldwina@brightwayslearning.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - lib/built_in_data.rb
 - lib/built_in_data/version.rb
-- test/built_in_data_test.rb
-- test/dummy/README.rdoc
-- test/dummy/Rakefile
-- test/dummy/app/assets/config/manifest.js
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/models/national_park.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/bin/bundle
-- test/dummy/bin/rails
-- test/dummy/bin/rake
-- test/dummy/config.ru
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/assets.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/cookies_serializer.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/routes.rb
-- test/dummy/config/secrets.yml
-- test/dummy/db/built_in_data/national_parks.yml
-- test/dummy/db/migrate/20121024195810_create_national_parks.rb
-- test/dummy/db/migrate/20121024201818_add_built_in_key_to_national_parks.rb
-- test/dummy/db/migrate/20121101224000_add_protected_attribute_column_to_national_parks.rb
-- test/dummy/db/migrate/20141111224715_remove_protected_attribute_column_from_national_parks.rb
-- test/dummy/db/migrate/20141113214328_add_active_to_national_parks.rb
-- test/dummy/db/schema.rb
-- test/dummy/db/test.sqlite3
-- test/dummy/log/test.log
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/test_helper.rb
 homepage: https://github.com/wwidea/built_in_data
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/wwidea/built_in_data
+  source_code_uri: https://github.com/wwidea/built_in_data
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -96,61 +53,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.6
+rubygems_version: 3.4.5
 signing_key:
 specification_version: 4
 summary: Data management for Rails models.
-test_files:
-- test/dummy/app/models/national_park.rb
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/app/assets/config/manifest.js
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/bin/rake
-- test/dummy/bin/bundle
-- test/dummy/bin/rails
-- test/dummy/config/secrets.yml
-- test/dummy/config/routes.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/environment.rb
-- test/dummy/config/application.rb
-- test/dummy/config/database.yml
-- test/dummy/config/boot.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/initializers/assets.rb
-- test/dummy/config/initializers/cookies_serializer.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config.ru
-- test/dummy/Rakefile
-- test/dummy/public/favicon.ico
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/404.html
-- test/dummy/db/schema.rb
-- test/dummy/db/test.sqlite3
-- test/dummy/db/built_in_data/national_parks.yml
-- test/dummy/db/migrate/20121101224000_add_protected_attribute_column_to_national_parks.rb
-- test/dummy/db/migrate/20121024195810_create_national_parks.rb
-- test/dummy/db/migrate/20121024201818_add_built_in_key_to_national_parks.rb
-- test/dummy/db/migrate/20141111224715_remove_protected_attribute_column_from_national_parks.rb
-- test/dummy/db/migrate/20141113214328_add_active_to_national_parks.rb
-- test/dummy/log/test.log
-- test/dummy/README.rdoc
-- test/built_in_data_test.rb
-- test/test_helper.rb
+test_files: []

data/README.rdoc

@@ -1,53 +0,0 @@
-=BuiltInData
-
-{<img src="https://codeclimate.com/github/wwidea/built_in_data/badges/gpa.svg" />}[https://codeclimate.com/github/wwidea/built_in_data]
-
-BuiltInData is a simple tool for loading and updating data in a Rails application.
-
-Objects are stored in the database with a *built_in_key* that is used on subsequent loads to update or remove the object.
-Items in the table without a *built_in_key* will not be modified or removed.
-
-BuiltInData is designed to address the data gray area between customer data and constants.
-It allows developers to deliver, update, and destroy data that is stored in the database.
-
-== Setup
-Add *built_in_key* to your model:
-
-    ruby script/rails generate migration AddBuiltInKeyToYourModel built_in_key:string:index
-    rake db:migrate
-
-Include *BuiltInData* in your model:
-
-    class YourModel < ActiveRecord::Base
-      include BuiltInData
-    end
-
-== Loading Data
-There are two methods to load data
-
-* Pass as a hash to load_built_in_data!
-    YourModel.load_built_in_data!({
-      :glacier => {
-        :name => 'Glacier National Park',
-      },
-
-      :yellowstone => {
-        :name => 'Yellowstone National Park',
-      }
-    })
-
-
-* Create a yaml load file in *db/built_in_data* with the name of the model (ie. national_parks.yml), and load the data with <tt>YourModel.load_built_in_data!</tt> without any arguments.  The yaml file can contain erb.
-
-    glacier:
-      name: Glacier National Park
-      established: <%= Date.parse('1910-05-11') %>
-
-    yellowstone:
-     name: Yellowstone National Park
-     established: 1872-03-01
-
-== Other
-Use *built_in?* to check if an object was loaded by BuiltInData:
-
-    object.built_in?

data/test/built_in_data_test.rb

@@ -1,104 +0,0 @@
-require 'test_helper'
-
-class BuiltInDataTest < ActiveSupport::TestCase
-  HASH_DATA = {
-    test: {
-      name:         'Yellowstone National Park',
-      established:  '1872-03-01',
-      url:          'http://www.nps.gov/yell/index.htm',
-    }
-  }
-  
-  test 'should return true for built_in?' do
-    assert_equal true, NationalPark.new(built_in_key: 'test').built_in?
-  end
-  
-  test 'should return false for built_in?' do
-    assert_equal false, NationalPark.new(built_in_key: '').built_in?
-  end
-  
-  test "should load built in data" do
-    assert_difference 'NationalPark.count' do
-      load_hash_data
-    end
-
-    assert_equal 'Yellowstone National Park', NationalPark.find_by_built_in_key('test').name
-  end
-
-  test "should remove built in data" do
-    load_hash_data
-
-    assert_difference 'NationalPark.count', -1 do
-      NationalPark.load_built_in_data!({})
-    end
-
-    assert_nil NationalPark.find_by_built_in_key('test')
-  end
-
-  test "should not remove a record without a built_in_key" do
-    park = NationalPark.create(:name => 'Testing')
-
-    assert_difference 'NationalPark.count', 1 do
-      load_hash_data
-    end
-    assert_equal 'Testing', park.reload.name
-  end
-
-  test "should update existing built in data" do
-    load_hash_data
-    assert_not_equal 'http://en.wikipedia.org/wiki/Yellowstone_National_Park', NationalPark.find_by_built_in_key('test').url
-    modified_hash = HASH_DATA.dup
-    modified_hash[:test][:url] = 'http://en.wikipedia.org/wiki/Yellowstone_National_Park'
-    NationalPark.load_built_in_data!(modified_hash)
-    assert_equal 'http://en.wikipedia.org/wiki/Yellowstone_National_Park', NationalPark.find_by_built_in_key('test').url
-  end
-
-  test "should load built in data from yaml file" do
-    assert_difference 'NationalPark.count', 2 do
-      NationalPark.load_built_in_data!
-    end
-  end
-
-  test "should load elements from file only once" do
-    NationalPark.load_built_in_data!
-
-    assert_no_difference 'NationalPark.count' do
-      NationalPark.load_built_in_data!
-    end
-  end
-
-  test "should process erb in yaml file" do
-    assert_equal '1910-05-11', NationalPark.send(:load_yaml_data)['glacier']['established'].to_s(:db)
-  end
-
-  test 'should return active record objects from load' do
-    parks = NationalPark.load_built_in_data!
-    assert_equal(2,parks.size)
-    assert_equal(NationalPark,parks.first.class)
-    assert_equal(false,parks.first.new_record?)
-  end
-  
-  test 'should load yaml defaults' do
-    NationalPark.load_built_in_data!
-    assert_equal true, NationalPark.find_by(name: 'Yellowstone National Park').active
-  end
-  
-  test 'should return built_in_data object database id' do
-    load_hash_data
-    assert_equal NationalPark.where(name: 'Yellowstone National Park').first.id, NationalPark.built_in_object_id(:test)
-  end
-  
-  test 'should clear built_in_object_ids cache when delete_all is called' do
-    NationalPark.instance_variable_set('@built_in_object_ids', 'testing')
-    
-    NationalPark.delete_all
-    assert_nil NationalPark.instance_variable_get('@built_in_object_ids')
-  end
-
-  private
-
-  def load_hash_data
-    NationalPark.load_built_in_data!(HASH_DATA)
-  end
-
-end

data/test/dummy/README.rdoc

@@ -1,28 +0,0 @@
-== README
-
-This README would normally document whatever steps are necessary to get the
-application up and running.
-
-Things you may want to cover:
-
-* Ruby version
-
-* System dependencies
-
-* Configuration
-
-* Database creation
-
-* Database initialization
-
-* How to run the test suite
-
-* Services (job queues, cache servers, search engines, etc.)
-
-* Deployment instructions
-
-* ...
-
-
-Please feel free to use a different markup language if you do not plan to run
-<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -1,6 +0,0 @@
-# Add your own tasks in files placed in lib/tasks ending in .rake,
-# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
-
-require File.expand_path('../config/application', __FILE__)
-
-Rails.application.load_tasks

data/test/dummy/app/assets/config/manifest.js

@@ -1,4 +0,0 @@
-
-//= link_tree ../images
-//= link_directory ../javascripts .js
-//= link_directory ../stylesheets .css

data/test/dummy/app/assets/javascripts/application.js

@@ -1,13 +0,0 @@
-// This is a manifest file that'll be compiled into application.js, which will include all the files
-// listed below.
-//
-// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
-// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
-//
-// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-// compiled file.
-//
-// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
-// about supported directives.
-//
-//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any styles
- * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
- * file per style scope.
- *
- *= require_tree .
- *= require_self
- */

data/test/dummy/app/controllers/application_controller.rb

@@ -1,5 +0,0 @@
-class ApplicationController < ActionController::Base
-  # Prevent CSRF attacks by raising an exception.
-  # For APIs, you may want to use :null_session instead.
-  protect_from_forgery with: :exception
-end

data/test/dummy/app/helpers/application_helper.rb

@@ -1,2 +0,0 @@
-module ApplicationHelper
-end

data/test/dummy/app/models/national_park.rb

@@ -1,3 +0,0 @@
-class NationalPark < ActiveRecord::Base
-  include BuiltInData
-end

data/test/dummy/app/views/layouts/application.html.erb

@@ -1,14 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>Dummy</title>
-  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
-  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
-  <%= csrf_meta_tags %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
-</html>

data/test/dummy/bin/bundle

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
-load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -1,4 +0,0 @@
-#!/usr/bin/env ruby
-APP_PATH = File.expand_path('../../config/application',  __FILE__)
-require_relative '../config/boot'
-require 'rails/commands'

data/test/dummy/bin/rake

@@ -1,4 +0,0 @@
-#!/usr/bin/env ruby
-require_relative '../config/boot'
-require 'rake'
-Rake.application.run

data/test/dummy/config/application.rb

@@ -1,22 +0,0 @@
-require File.expand_path('../boot', __FILE__)
-
-require 'rails/all'
-
-Bundler.require(*Rails.groups)
-require "built_in_data"
-
-module Dummy
-  class Application < Rails::Application
-    # Settings in config/environments/* take precedence over those specified here.
-    # Application configuration should go into files in config/initializers
-    # -- all .rb files in that directory are automatically loaded.
-
-    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
-    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
-    # config.time_zone = 'Central Time (US & Canada)'
-
-    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
-    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
-    # config.i18n.default_locale = :de
-  end
-end

data/test/dummy/config/boot.rb

@@ -1,5 +0,0 @@
-# Set up gems listed in the Gemfile.
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
-
-require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
-$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)