constant_record 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c54e7e14d065796037c8c68789bf16ed980cbdc
-  data.tar.gz: e2756dc08f225ce136ac3f07dc20d1b773fa579e
+  metadata.gz: ddf57212499798179e38bd340e90f0ae680629ac
+  data.tar.gz: 9ae1ca8ef06c517f9a834c6c29e5ccfe4f53e95d
 SHA512:
-  metadata.gz: 56847eabe09d8c35111905feca49d35e8dafc5ea70226b213e05c116ea01b75d61709aa6e553e3aa5902a22e7a910232082cf3c7663cd1f2605b64f4f254059d
-  data.tar.gz: d5c59bf34e24b0ab5b7fbfcd509de8c5e006cf164528dada95de3a6183486f412c40b4214a1eafcd5be97676c0975f6a9f9030ea2d776070bac7b0cada8bb6e8
+  metadata.gz: cce30cf09c75bf5a30b13f2a38e25ac4ae2dcfbe14d31b76e055d34f9f63f6c4fe6f3cc873a2df006da63a902155bdfee3e35687031de38ec2595b39c9ff263f
+  data.tar.gz: 95ae356510c8d29ae59bf5e1551e71e1f1dbe72c8894f680c64c7303290a71acf281a73fe99414f7e12736fa89fe93f8ae50f6362647ec05ba46922c2006872f

data/README.md

@@ -8,7 +8,7 @@ Compatible with all current versions of Rails, from 3.x up through 4.1
 Unlike previous (ambitious) approaches that have tried to duplicate ActiveRecord
 functionality in a separate set of classes, this is a simple shim of < 200 LOC
 that creates an in-memory SQLite database for the relevant models.  This is designed
-to minimize breakage between Rails versions, and also avoids recreating ActiveRecord
+to minimize breakage between Rails versions, and also avoids reimplementing ActiveRecord
 features.
 
 ## Installation
@@ -25,12 +25,10 @@ Then run `bundle install`. Or, install it yourself manually, if you're into that
 
 ## Usage
 
-Just `include ConstantRecord` in any ActiveRecord class. Then, you can use `data` to add
-data directly in that class for clarity:
-
-    class Genre < ActiveRecord::Base
-      include ConstantRecord
+Inherit from `ConstantRecord::Base` just like you would with ActiveRecord.
+Then, you can use `data` to add data directly in that class for clarity:
 
+    class Genre < ConstantRecord::Base
       data id: 1, name: "Rock",    slug: "rock"
       data id: 2, name: "Hip-Hop", slug: "hiphop"
       data id: 3, name: "Pop",     slug: "pop"
@@ -38,8 +36,7 @@ data directly in that class for clarity:
 
 Or, you can choose to keep your data in a YAML file:
 
-    class Genre < ActiveRecord::Base
-      include ConstantRecord
+    class Genre < ConstantRecord::Base
       load_data File.join(Rails.root, 'config', 'data', 'genres.yml')
     end
 
@@ -59,8 +56,7 @@ The YAML file should be an array of hashes:
 
 You can omit the filename if it follows the naming convention of `config/data/[table_name].yml`:
 
-    class Genre < ActiveRecord::Base
-      include ConstantRecord
+    class Genre < ConstantRecord::Base
       load_data  # config/data/genres.yml
     end
 
@@ -76,9 +72,7 @@ you use in the *first* `data` declaration.  **Important:** This means if you hav
 columns that aren't always present, *make sure to include them with `column_name: nil` on
 the first `data` line:*
 
-    class Genre < ActiveRecord::Base
-      include ConstantRecord
-
+    class Genre < ConstantRecord::Base
       data id: 1, name: "Rock",    slug: "rock",   region: nil, country: nil
       data id: 2, name: "Hip-Hop", slug: "hiphop", region: 'North America'
       data id: 3, name: "Pop",     slug: "pop",    country: 'US'
@@ -98,47 +92,19 @@ Attempts to modify values will fail:
 
 You'll get an `ActiveRecord::ReadOnlyRecord` exception.
 
-## Auto Constants
-
-ConstantRecord will also create constants on the fly for you if you have a `name` column.
-Revisiting our example:
-
-    class Genre < ActiveRecord::Base
-      include ConstantRecord
-
-      data id: 1, name: "Rock",    slug: "rock"
-      data id: 2, name: "Hip-Hop", slug: "hiphop"
-      data id: 3, name: "Pop",     slug: "pop"
-    end
-
-This will create:
-
-    Genre::ROCK = 1
-    Genre::HIP_HOP = 2
-    Genre::POP = 3
-
-This makes it cleaner to do queries in your app:
-
-    Genre.find(Genre::ROCK)
-    Song.where(genre_id: Genre::ROCK)
-
-And so on.
-
 ## Associations
 
 Internally, ActiveRecord tries to do joins to retrieve associations.  This doesn't work, since
 the records live in different tables.  Have no fear, you just need to `include ConstantRecord::Associations`
-in the normal ActiveRecord class that is trying to associate to your ConstantRecord class:
-
-    class Genre < ActiveRecord::Base
-      include ConstantRecord
+in the ActiveRecord class that is trying to associate to your ConstantRecord class:
 
+    class Genre < ConstantRecord::Base
       has_many :song_genres
       has_many :songs, through: :song_genres
 
-      data id: 1, name: "Rock",    slug: "rock",   region: nil, country: nil
-      data id: 2, name: "Hip-Hop", slug: "hiphop", region: 'North America'
-      data id: 3, name: "Pop",     slug: "pop",    country: 'US'
+      data id: 1, name: "Rock",    slug: "rock"
+      data id: 2, name: "Hip-Hop", slug: "hiphop"
+      data id: 3, name: "Pop",     slug: "pop"
     end
 
     class SongGenre < ActiveRecord::Base
@@ -147,7 +113,7 @@ in the normal ActiveRecord class that is trying to associate to your ConstantRec
     end
 
     class Song < ActiveRecord::Base
-      include ConstantRecord::Associations
+      include ConstantRecord::Associations  # <-- IMPORTANT
       has_many :song_genres
       has_many :songs, through: :song_genres
     end
@@ -161,12 +127,35 @@ If you forget to do this, you'll get an error like this:
 It would be great to remove this shim, but I can't currently see a way without monkey-patching
 the internals of ActiveRecord, which I don't want to do for 17 different reasons.
 
+## Auto Constants
+
+ConstantRecord will also create constants on the fly for you if you have a `name` column.
+Revisiting our example:
+
+    class Genre < ConstantRecord::Base
+      data id: 1, name: "Rock",    slug: "rock"
+      data id: 2, name: "Hip-Hop", slug: "hiphop"
+      data id: 3, name: "Pop",     slug: "pop"
+    end
+
+This will create:
+
+    Genre::ROCK = 1
+    Genre::HIP_HOP = 2
+    Genre::POP = 3
+
+This makes it cleaner to do queries in your app:
+
+    Genre.find(Genre::ROCK)
+    Song.where(genre_id: Genre::ROCK)
+
+And so on.
+
 ## Debugging
 
 If you forget to define data, you'll get a "table doesn't exist" error:
 
-    class Publisher < ActiveRecord::Base
-      include ConstantRecord
+    class Publisher < ConstantRecord::Base
 
       # Oops no data
 
@@ -182,9 +171,7 @@ This is because the table is created lazily when you first load data.
 
 If you try to add a custom column on a different `data` line:
 
-    class Genre < ActiveRecord::Base
-      include ConstantRecord
-
+    class Genre < ConstantRecord::Base
       data id: 1, name: "Rock",    slug: "rock"
       data id: 2, name: "Hip-Hop", slug: "hiphop"
       data id: 3, name: "Pop",     slug: "pop", ranking: 1  # oops

data/lib/constant_record/version.rb

@@ -1,3 +1,3 @@
 module ConstantRecord
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/lib/constant_record.rb

@@ -1,10 +1,8 @@
 #
-# To use, `include ConstantRecord` in any ActiveRecord class. Then, you can use `data`
-# to add data directly in that class for clarity:
-#
-#     class Genre < ActiveRecord::Base
-#       include ConstantRecord
+# Inherit from `ConstantRecord::Base` just like you would with ActiveRecord.
+# Then, you can use `data` to add data directly in that class for clarity:
 #
+#     class Genre < ConstantRecord::Base
 #       data id: 1, name: "Rock",    slug: "rock"
 #       data id: 2, name: "Hip-Hop", slug: "hiphop"
 #       data id: 3, name: "Pop",     slug: "pop"
@@ -12,8 +10,7 @@
 #
 # Or, you can choose to keep your data in a YAML file:
 #
-#     class Genre < ActiveRecord::Base
-#       include ConstantRecord
+#     class Genre < ConstantRecord::Base
 #       load_data File.join(Rails.root, 'config', 'data', 'genres.yml')
 #     end
 #
@@ -27,18 +24,9 @@ module ConstantRecord
   class Error < StandardError; end
   class BadDataFile < Error;   end
 
-  MEMORY_DBCONFIG = {adapter: 'sqlite3', database: ":memory:", pool: 5}.freeze
-
+  DATABASE_CONFIG = { adapter: 'sqlite3', database: ":memory:", pool: 5 }.freeze
 
   class << self
-    def memory_dbconfig
-      @memory_dbconfig || MEMORY_DBCONFIG
-    end
-
-    def memory_dbconfig=(config)
-      @memory_dbconfig = config
-    end
-
     def data_dir
       @data_dir || File.join('config', 'data')
     end
@@ -46,13 +34,6 @@ module ConstantRecord
     def data_dir=(path)
       @data_dir = path
     end
-
-    def included(base)
-      base.extend DataLoading
-      base.extend Associations
-      base.send :include, ReadOnly
-      base.establish_connection(memory_dbconfig) unless base.send :connected?
-    end
   end
 
   #
@@ -77,6 +58,7 @@ module ConstantRecord
       end
 
       # Call our method to populate data
+      @data_rows = []
       records.each{|r| data r}
 
       @loaded = true
@@ -91,30 +73,35 @@ module ConstantRecord
     end
 
     # Define a constant record: data id: 1, name: "California", slug: "CA"
-    def data(attrib)
-      attrib.symbolize_keys!
+    def data(attrib, reload=false)
       raise ArgumentError, "#{self}.data expects a Hash of attributes" unless attrib.is_a?(Hash)
+      attrib.symbolize_keys!
 
       unless attrib[primary_key.to_sym]
         raise ArgumentError, "#{self}.data missing primary key '#{primary_key}': #{attrib.inspect}"
       end
 
-      unless @table_was_created
-        create_memory_table(attrib)
-        @table_was_created = true
+      # Save data definitions for reload on connection change
+      @data_rows ||= []
+
+      # Check for duplicates
+      unless reload
+        if old_record = @data_rows.detect{|r| r[primary_key.to_sym] == attrib[primary_key.to_sym] }
+          raise ActiveRecord::RecordNotUnique,
+            "Duplicate #{self} id=#{attrib[primary_key.to_sym]} found: #{attrib} vs #{old_record}"
+        end
+        @data_rows << attrib
       end
 
+      # Create table dynamically based on first row of data
+      create_memory_table(attrib) unless connection.table_exists?(table_name)
+
+      # Save to in-memory table
       new_record = new(attrib)
       new_record.id = attrib[primary_key.to_sym]
-
-      # Check for duplicates
-      if old_record = find_by_id(new_record.id)
-        raise ActiveRecord::RecordNotUnique,
-          "Duplicate #{self} id=#{new_record.id} found: #{new_record} vs #{old_record}"
-      end
       new_record.save!
 
-      # create Ruby constants as well, so "id: 3, name: Sky" gets SKY=3
+      # Create Ruby constants as well, so "id: 3, name: Sky" generates SKY=3
       if new_record.respond_to?(:name) and name = new_record.name
         const_name =
           name.to_s.upcase.strip.gsub(/[-\s]+/,'_').sub(/^[0-9_]+/,'').gsub(/\W+/,'')
@@ -146,6 +133,12 @@ module ConstantRecord
         end
       end
     end
+
+    # Reloads the table when the connection has changed
+    def reload_memory_table
+      return false unless @data_rows
+      @data_rows.each{|r| data r, true}
+    end
   end
 
   #
@@ -153,7 +146,7 @@ module ConstantRecord
   #
   module Associations
     def self.included(base)
-      base.extend self # support "include" as well
+      base.extend self # support "include"
     end
 
     #
@@ -163,7 +156,9 @@ module ConstantRecord
     # so that we're not making real DB calls.
     #
     def has_many(other_table, options={})
-      # puts "#{self}(#{table_name}).has_many #{other_table.inspect}, #{options.inspect}"
+      super other_table, options.dup # make AR happy
+
+      # Redefine association method in the class
       if join_tab = options[:through]
         foreign_key = options[:foreign_key] || other_table.to_s.singularize.foreign_key
         prime_key   = options[:primary_key] || primary_key
@@ -176,8 +171,6 @@ module ConstantRecord
           return [] if ids.empty?
           class_name.constantize.where(id: ids)
         end
-      else
-        super other_table, options
       end
     end
   end
@@ -217,4 +210,27 @@ module ConstantRecord
       end
     end
   end
+
+  #
+  # Base class to inherit from so we can share the same memory database
+  #
+  class Base < ActiveRecord::Base
+    extend  DataLoading
+    extend  Associations
+    include ReadOnly
+
+    # Reload table if connection changes. Since it's in-memory, a connection
+    # change means the the table gets wiped.
+    def self.connection
+      conn = super
+      if (@previous_connection ||= conn) != conn
+        @previous_connection = conn # avoid infinite loop
+        reload_memory_table
+      end
+      conn
+    end
+
+    self.abstract_class = true
+    establish_connection ConstantRecord::DATABASE_CONFIG
+  end
 end

data/spec/constant_record_spec.rb

@@ -1,6 +1,30 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "ConstantRecord" do
+  describe "connection" do
+    it "has an in-memory DB" do
+      dbconfig = Author.connection.instance_variable_get(:@config)
+      dbconfig[:adapter].should  == "sqlite3"
+      dbconfig[:database].should == ":memory:"
+    end
+
+    it "shares the same database" do
+      Author.connection.should == Publisher.connection
+      Author.connection.should == ConstantRecord::Base.connection
+    end
+
+    it "reloads the table on connection change" do
+      Publisher.load_data
+      old_con = Publisher.connection
+      pub_ids = Publisher.pluck(:id)
+      ConstantRecord::Base.remove_connection
+      new_con = Publisher.connection
+      new_con.should != old_con
+      Publisher.pluck(:id).should == pub_ids
+      Publisher.where('id is not null').delete_all # hackaround ReadOnlyRecord
+    end
+  end
+
   describe "loading data" do
     it "data(attr: val)" do
       date1 = Time.now
@@ -93,7 +117,7 @@ describe "ConstantRecord" do
       author.articles.find(4).id.should == 4
     end
 
-    it "has_many through (up)" do
+    it "has_many through (down)" do
       ArticlePublisher.create!(article_id: 4,  publisher_id: 7)
       ArticlePublisher.create!(article_id: 5,  publisher_id: 7)
       ArticlePublisher.create!(article_id: 60, publisher_id: 7) # bogus
@@ -106,13 +130,15 @@ describe "ConstantRecord" do
       end
     end
 
-    it "has_many through (down)" do
+    it "has_many through (up)" do
       ArticlePublisher.create!(article_id: 2, publisher_id: 1)
       ArticlePublisher.create!(article_id: 2, publisher_id: 2)
       ArticlePublisher.create!(article_id: 2, publisher_id: 30) # bogus
       article = Article.find(2)
       article.article_publishers.count.should == 3
       article.publishers.count.should == 2
+      publisher = article.publishers.find(1)
+      publisher.should == Publisher.find(1)
     end
   end
 

data/spec/spec_helper.rb

@@ -32,15 +32,11 @@ if ENV['DEBUG']
   ActiveRecord::Base.logger.level = Logger::DEBUG
 end
 
-class Author < ActiveRecord::Base
-  include ConstantRecord
-
+class Author < ConstantRecord::Base
   has_many :articles
 end
 
-class Publisher < ActiveRecord::Base
-  include ConstantRecord
-
+class Publisher < ConstantRecord::Base
   has_many :article_publishers
   has_many :articles, through: :article_publishers
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: constant_record
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Nate Wiger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-18 00:00:00.000000000 Z
+date: 2014-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord