mince 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9289921e574adca62309c4dba6ee0f15d257bd39
-  data.tar.gz: 0a11a1df9dd21d16ee02843ccb9c062cafb88ada
+  metadata.gz: d691deea536ba372175b37a2c0172b19b444de75
+  data.tar.gz: 6273bb8e9b649e122f162ce7c95df290486cf961
 SHA512:
-  metadata.gz: 395c89bc97cacc641a4380f0a28c2ffa06761f4f3ee94a31759c1b9a0e65ea4a6244cdc88686c4d9be615cef839298d226dabe87fd4456257f120ca7800a3e99
-  data.tar.gz: c35e8428c60ab564b19fdfce9239bac3fbaa8d0e3cbc15887811ecbe5c836977bad42db3cdf43d6981b6af880ff696aff2fc484b10b014f428c716fd7ba46c53
+  metadata.gz: 8b840fbc99a80dc42e94767738877a0fa5fa71b9ae20fbe9bcda8bdb9e33b265dcabe7761c17d9d8180d68b0f8ecceca2f57168a4315743b2dc48b08ece356bb
+  data.tar.gz: 5eb6ee075cc5808d319a4689ba47740f711b82344c37394fa02f641d2eb2555f9055d95a23a02d2990608b27a084e5d151a89c4ba4bfc2d674298f5521ab1861

data/README.md

@@ -65,10 +65,11 @@ Link | Description
 ----|-----
 [API Docs](http://rdoc.info/github/coffeencoke/mince/master/frames) | API docs for Mince
 [Existing Interfaces](https://github.com/coffeencoke/mince/wiki/Existing-interfaces) | List of supported database interfaces that can be used with Mince
+[Mince Migrator](http://coffeencoke.github.io/mince_migrator) | Database migrations library for Mince
 [Usage with Rails](https://github.com/coffeencoke/mince/wiki/Usage-with-rails) | More information on how to use Mince with Rails
 [Fancy Mixins](https://github.com/coffeencoke/mince/wiki/Fancy-mixins) | We've written a few mixins that provide some standard behavior to your models while using Mince
 [Development](https://github.com/coffeencoke/mince/wiki/Development) | Help by contributing
-[Mailing List](https://groups.google.com/forum/?fromgroups#!forum/mince_dev)
+[Mailing List](https://groups.google.com/forum/?fromgroups#!forum/mince_dev) | Mailing list for Mince
 [Travis CI](https://travis-ci.org/#!/coffeencoke/mince) | Check out the build status of Mince
 [Why Multitier Architecture?](https://github.com/coffeencoke/mince/wiki/Why-multitier-architecture%3F) | Discussion about why to use multi tier architecture as apposed to others, such as Active Record
 
@@ -90,6 +91,12 @@ Helena Converse | [@n3rdgir1](https://twitter.com/n3rdgir1) | [@n3rdgir1](https:
 
 If you've been missed on this list, let us know by creating an issue or sending one of us a message.
 
+# License
+
+Copyright 2013 Matt Simpson
+
+MIT - view LICENSE.txt in the source for details
+
 # Version 1
 
 Looking for support for Version 1? Put an issue in, or send one of us a message.

data/lib/mince/data_model.rb

@@ -33,6 +33,8 @@ module Mince # :nodoc:
   #
   # View the docs for each method available
   module DataModel
+    require_relative 'data_model/timestamps'
+
     extend ActiveSupport::Concern
 
     included do
@@ -48,6 +50,16 @@ module Mince # :nodoc:
         Config.interface
       end
 
+      # Allows models to define fields without the data model needing to define them also
+      def infer_fields_from_model
+        @infer_fields_from_model = true
+      end
+
+      # Returns true if the data model is infering fields from the model
+      def infer_fields?
+        !!@infer_fields_from_model
+      end
+
       # Sets what data fields to accept
       # Returns the fields
       #
@@ -57,6 +69,7 @@ module Mince # :nodoc:
       # @param [*Array] *fields an array of fields to add to the data model
       # @returns [Array] the fields defined for the data model
       def data_fields(*fields)
+        @data_fields ||= []
         create_data_fields(*fields) if fields.any?
         @data_fields
       end
@@ -76,9 +89,7 @@ module Mince # :nodoc:
       # @param [Class] model a ruby class instance object to store into the data store
       # @returns [id] returns the id of the newly stored object
       def store(model)
-        new(model).tap do |p|
-          p.add_to_interface
-        end.id
+        new(model).create
       end
 
       # Updates the given model in the data store with the fields and values in model
@@ -87,9 +98,7 @@ module Mince # :nodoc:
       #
       # @param [Class] model a ruby class instance object to store into the data store
       def update(model)
-        new(model).tap do |p|
-          p.replace_in_interface
-        end
+        new(model).update
       end
 
       # Updates a specific field with a value for the record with the given id
@@ -99,6 +108,7 @@ module Mince # :nodoc:
       # @param [*] value the value to update the field with
       def update_field_with_value(id, field, value)
         interface.update_field_with_value(data_collection, id, field, value)
+        set_update_timestamp_for(data_collection, id) if timestamps?
       end
 
       # Increments a field by a given amount
@@ -111,6 +121,7 @@ module Mince # :nodoc:
       # @param [Numeric] amount the amount to increment or decrement the field with
       def increment_field_by_amount(id, field, amount)
         interface.increment_field_by_amount(data_collection, id, field, amount)
+        set_update_timestamp_for(data_collection, id) if timestamps?
       end
 
       # Removes a value from an field that is an array
@@ -120,6 +131,7 @@ module Mince # :nodoc:
       # @param [*] value the value to update the field with
       def remove_from_array(id, field, value)
         interface.remove_from_array(data_collection, id, field, value)
+        set_update_timestamp_for(data_collection, id) if timestamps?
       end
 
       # Pushes a value to an array field
@@ -129,6 +141,7 @@ module Mince # :nodoc:
       # @param [*] value the value to update the field with
       def push_to_array(id, field, value)
         interface.push_to_array(data_collection, id, field, value)
+        set_update_timestamp_for(data_collection, id) if timestamps?
       end
 
       # Returns a record that has the given id
@@ -236,9 +249,15 @@ module Mince # :nodoc:
       # @returns [Hash] the data that was added to the data collection, including the uniquely generated id
       def add(hash)
         hash = HashWithIndifferentAccess.new(hash.merge(primary_key => generate_unique_id(hash)))
+        add_timestamps_to_hash(hash) if timestamps?
         interface.add(data_collection, hash).first
       end
 
+      # Returns true if the data model uses the Timestamps mixin
+      def timestamps?
+        include? Mince::DataModel::Timestamps
+      end
+
       def translate_from_interface(hash)
         if hash
           hash["id"] = hash[primary_key] if hash[primary_key] && (primary_key != :id || primary_key != 'id')
@@ -250,19 +269,19 @@ module Mince # :nodoc:
         data.collect {|d| translate_from_interface(d) }
       end
 
-      private
-
       def primary_key
         @primary_key ||= interface.primary_key
       end
 
+      private
+
       def set_data_collection(collection_name)
         @data_collection = collection_name
       end
 
       def create_data_fields(*fields)
         attr_accessor *fields
-        @data_fields = fields
+        @data_fields += fields
       end
     end
 
@@ -272,14 +291,36 @@ module Mince # :nodoc:
       set_id
     end
 
+    def create
+      update_timestamps if timestamps?
+      add_to_interface
+      id
+    end
+
+    def update
+      update_timestamps if timestamps?
+      replace_in_interface
+    end
+
+    def timestamps?
+      self.class.timestamps?
+    end
+
     def interface
       self.class.interface
     end
 
     def data_fields
+      if infer_fields?
+        self.class.data_fields *model.fields
+      end
       self.class.data_fields
     end
 
+    def infer_fields?
+      self.class.infer_fields?
+    end
+
     def data_collection
       self.class.data_collection
     end
@@ -292,12 +333,14 @@ module Mince # :nodoc:
       interface.replace(data_collection, attributes)
     end
 
-    private
-
     def attributes
-      model_instance_values.merge(primary_key => id)
+      model_instance_values.merge(primary_key => id).tap do |hash|
+        hash.merge!(timestamp_attributes) if timestamps?
+      end
     end
 
+    private
+
     def model_instance_values
       HashWithIndifferentAccess.new(model.instance_values).slice(*data_fields)
     end
@@ -319,7 +362,7 @@ module Mince # :nodoc:
     end
 
     def primary_key
-      interface.primary_key
+      self.class.primary_key
     end
 
     def set_data_field_value(field)

data/lib/mince/data_model/timestamps.rb

@@ -0,0 +1,60 @@
+module Mince
+  module DataModel
+    require 'active_support/concern'
+    require_relative '../data_model'
+
+    # = Timestamps
+    #
+    # Timestamps can be mixed into your DataModel classes in order to provide with fields
+    # to store when records are created and updated.
+    #
+    # Example:
+    #   require 'mince/data_model'
+    #
+    #   Class UserDataModel
+    #     include Mince::DataModel
+    #     include Mince::DataModel::Timestamps
+    #
+    #     data_collection :users
+    #     data_fields :username
+    #   end
+    #
+    #   UserDataModel.add username: 'coffeencoke'
+    #   data_model = UserDataModel.find_by_field :username, 'coffeencoke'
+    #   data_model.created_at # => todo: returns date time in utc
+    #   data_model.updated_at # => todo: returns date time in utc
+    #
+    # Whenever a database persisting message is called for a record, the updated_at
+    # timestamp will be updated.
+    module Timestamps
+      include Mince::DataModel
+
+      extend ActiveSupport::Concern
+
+      included do
+        data_fields :created_at, :updated_at
+      end
+
+      module ClassMethods # :nodoc:
+        def add_timestamps_to_hash(hash)
+          now = Time.now.utc
+          hash.merge!(created_at: now, updated_at: now)
+        end
+
+        def set_update_timestamp_for(data_collection, id)
+          interface.update_field_with_value(data_collection, id, :updated_at, Time.now.utc)
+        end
+      end
+
+      def update_timestamps
+        now = Time.now.utc
+        self.created_at = now unless created_at
+        self.updated_at = now
+      end
+
+      def timestamp_attributes
+        { created_at: created_at, updated_at: updated_at }
+      end
+    end
+  end
+end

data/lib/mince/model.rb

@@ -33,7 +33,7 @@ module Mince
   #
   # By including this module, you are including DataModel, Fields, Persistence, and Finders.
   #
-  # However, you can choose which modules you would like by including those modules individually 
+  # However, you can choose which modules you would like by including those modules individually
   # so that you can have flexibility an lighter weight help to implement your models.
   #
   #   class AvailableBook

data/lib/mince/model/data_model.rb

@@ -21,11 +21,14 @@ module Mince
       # Not sure if this is where this method should live, it requires both
       # Mince::Model::DataModel and Mince::Model::Fields.
       def ensure_no_extra_fields
-        extra_fields = (fields - data_model.data_fields)
-        if extra_fields.any?
+        if !data_model.infer_fields? && extra_fields.any?
           raise "Tried to save a #{self.class.name} with fields not specified in #{data_model.name}: #{extra_fields.join(', ')}"
         end
       end
+
+      def extra_fields
+        @extra_fields ||= (fields - data_model.data_fields)
+      end
     end
   end
 end

data/lib/mince/model/finders.rb

@@ -11,9 +11,31 @@ module Mince
       end
 
       module ClassMethods
-        # Sets or returns the data model class for the model
-        def find_by_fields(*fields)
-          raise 'not implemented'
+        # Finds a model for the given field value pair
+        def find_by_field(field, value)
+          d = data_model.find_by_field(field, value)
+          new d if d
+        end
+
+        # Finds a model for the given hash
+        def find_by_fields(hash)
+          d = data_model.find_by_fields(hash)
+          new d if d
+        end
+
+        # Finds all fields that match the given field value pair
+        def all_by_field(field, value)
+          data_model.all_by_field(field, value).map{|a| new(a) }
+        end
+
+        # Finds all fields that match the given hash
+        def all_by_fields(hash)
+          data_model.all_by_fields(hash).map{|a| new(a) }
+        end
+
+        # Finds or initializes a model for the given hash
+        def find_or_initialize_by(hash)
+          find_by_fields(hash) || new(hash)
         end
 
         # Returns all models from the data model

data/lib/mince/version.rb

@@ -5,7 +5,7 @@ module Mince
     end
 
     def self.minor
-      1
+      2
     end
 
     def self.patch

data/spec/integration/inferred_data_fields_spec.rb

@@ -0,0 +1,62 @@
+require 'debugger'
+require 'mince'
+require 'hashy_db'
+require 'active_support/core_ext/numeric/time'
+
+describe 'A data model with inferred fields' do
+  subject { model_klass.new attributes }
+
+  let(:attributes) { { brand: brand, price: price, type: type, color: color } }
+  let(:brand) { mock }
+  let(:price) { mock }
+  let(:type) { mock }
+  let(:color) { mock }
+
+  before do
+    Mince::Config.interface = Mince::HashyDb::Interface
+    Mince::HashyDb::Interface.clear
+  end
+
+  after do
+    Mince::HashyDb::Interface.clear
+  end
+
+  describe 'a model with a limited set of mince model mixins' do
+    let(:model_klass) do
+      Class.new do
+        include Mince::Model
+
+        data_model(
+          Class.new do
+            include Mince::DataModel
+
+            data_collection :guitars
+            infer_fields_from_model
+          end
+        )
+        field :brand, assignable: true
+        field :price, assignable: true
+        field :type, assignable: true
+        field :color, assignable: true
+      end
+    end
+
+    it 'is initialized with the correct data' do
+      subject.brand.should == brand
+      subject.price.should == price
+      subject.type.should == type
+      subject.color.should == color
+    end
+
+    it 'persists the data when saved' do
+      subject.save
+
+      all = model_klass.all
+      all.size.should == 1
+      all.first.brand.should == brand
+      all.first.price.should == price
+      all.first.type.should == type
+      all.first.color.should == color
+    end
+  end
+end

data/spec/integration/mince_data_model_spec.rb

@@ -39,4 +39,56 @@ describe 'A mince data model integration spec' do
       object[primary_key].should_not be_nil
     end
   end
+
+  describe 'a mince data model with timestamps' do
+    subject { data_model_klass.new brand: mock }
+
+    let(:data_model_klass) do
+      Class.new do
+        include Mince::DataModel
+        include Mince::DataModel::Timestamps
+
+        data_collection :guitars
+        data_fields :brand
+      end
+    end
+
+    it 'provides a data field for the timestamps' do
+      subject.created_at.should be_nil
+      subject.updated_at.should be_nil
+      subject.data_fields.should =~ [:brand, :updated_at, :created_at]
+    end
+
+    context 'when the record is created' do
+      let(:persisted_data_model) { data_model_klass.find_by_field :brand, brand }
+      let(:brand) { 'Gibson' }
+
+      before do
+        data_model_klass.add brand: brand
+      end
+
+      it 'sets the created at timestamp' do
+        (persisted_data_model[:created_at] > 10.seconds.ago.utc && persisted_data_model[:created_at] < 10.seconds.from_now.utc).should be_true
+      end
+
+      it 'sets the updated at timestamp' do
+        (persisted_data_model[:updated_at] > 10.seconds.ago.utc && persisted_data_model[:updated_at] < 10.seconds.from_now.utc).should be_true
+      end
+    end
+
+    context 'when the record is updated' do
+      let(:persisted_data_model) { data_model_klass.find_by_field :brand, brand }
+      let(:brand) { 'Gibson' }
+
+      before do
+        data_model_klass.add brand: brand
+        data_model_klass.update_field_with_value persisted_data_model[:id], :updated_at, (Time.now - 10000).utc
+      end
+
+      it 'updates the updated at timestamp' do
+        persisted_data_model = data_model_klass.find_by_field(:brand, brand)
+        (persisted_data_model[:updated_at] > 10.seconds.ago.utc && persisted_data_model[:updated_at] < 10.seconds.from_now.utc).should be_true
+      end
+    end
+  end
 end