data_mapped 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01bded4d2da5ec16f311a87116a937582a0ee762
-  data.tar.gz: 3dc344357c0884312785568d6cbe51df84cf08ec
+  metadata.gz: 335c405bdd0df4ca6217569d675c938553473d37
+  data.tar.gz: 3e78dace180017e3c8424f036b2243f8a3973a13
 SHA512:
-  metadata.gz: 53d4d0f398569b675652f73ff26d60ca10e1ac55c3b75ad24c8f78367279cf32155fb07bf0e0385c875c9a06024b9982c9fc7a5f49695c33138f5c0aab32418c
-  data.tar.gz: d1d4f8bbeff670e0ee03bab66e8d5ab27220ad63597c5eb23675934675e4c165c330b36e578e37f3505e6765098d85145381a816198cd868aa62fd90135bb31b
+  metadata.gz: 26d26bf585825d9b62a7442118f72d13c34309c4c7447b21e4d6a6a99025247cf2b68393873cc68c170405e6290c1d9a39ed6215f0d58cf5c9f5b78409bac211
+  data.tar.gz: 12e8c7fbcc73ca1a5eae2df3a322c02b60eadd4fbad34c62a9d06710ae2df22013e245bb72a20306200c6beb33381d3dfd10d8a318eda0cbf11f5076a1febcfa

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Raj Shah
+Copyright (c) 2013 Rajiv Bakulesh Shah
 
 MIT License
 

data/README.md

@@ -1,6 +1,12 @@
 # DataMapped
 
-TODO: Write a gem description
+Ruby mixins for [DataMapper](http://datamapper.org/).
+[Don't repeat yourself](#normal-model),
+[control your join tables](#join-model-for-a-join-table),
+[prevent your resources from being deleted](#permanent-model-that-cant-be-destroyed),
+and [full-text search](#searchable-model) across your resources.
+
+
 
 ## Installation
 
@@ -16,9 +22,137 @@ Or install it yourself as:
 
     $ gem install data_mapped
 
+
+
 ## Usage
 
-TODO: Write usage instructions here
+### Normal Model
+
+This mixin sets up your class for DataMapper, and adds `@id`, `@created_at`,
+and `@updated_at` properties that behave as expected.
+
+**Rationale**: Don't repeat yourself.  Don't manually add the same standard
+properties to each of your models.
+
+    require 'data_mapped/model'
+    
+    class Movie
+		include DataMapped::Model
+		property :title, String, required: true
+		property :description, Text
+    end
+
+### Join Model (for a Join Table)
+
+This mixin sets up your class for DataMapper, and adds `@created_at` and
+`@updated_at` properties that behave as expected.  This join model differs
+from the [normal model](#normal-model) in that the join model doesn't add an
+`@id` property, as it expects for your class to define a composite primary key
+using `#belongs_to` relationships.
+
+**Rationale**: Tightly control your many-to-many associations.  This is a
+helpful pattern to do something to a movie resource any time an actor is
+associated with it.
+
+	require 'data_mapped/join'
+	require 'data_mapped/model'
+    
+	class Movie
+		include DataMapped::Model
+		property :title, String, required: true
+		property :description, Text
+		has n, :actors, through: Resource
+	end
+    
+	class Actor
+		include DataMapped::Model
+		property :name, String, required: true
+		has n, :movies, through: Resource
+	end
+    
+	class ActorMovie
+		include DataMapped::Join
+		belongs_to :actor, key: true
+		belongs_to :movie, key: true
+	end
+
+**Integration note**: Your join model class name must be a
+[Pascal case](http://c2.com/cgi/wiki?PascalCase), alphabetized concatenation
+of the names of the two models that you're joining.  Internally, DataMapper
+introspects your join model class name and uses it to determine the name of
+the join table in your database.
+
+### Permanent Model (that Can't be Destroyed)
+
+This mixin prevents resources of your class from being destroyed (at least in
+the typical fashion using
+[`#destroy`](http://rubydoc.info/github/datamapper/dm-core/master/DataMapper/Resource#destroy-instance_method)).
+It's meant to be used in conjunction with either the
+[normal model](#normal-model) or the
+[join model](#join-model-for-a-join-table) mixin.
+
+**Rationale**: Prevent accidentally deleting resources that shouldn't be
+deleted, if you have itchy fingers and play around too much in `irb` on
+production like I do.  Our use case is that movies should be created, read,
+and updated, but never deleted.
+
+	require 'data_mapped/model'
+	require 'data_mapped/permanent'
+	
+	class Movie
+		include DataMapped::Model
+		include DataMapped::Permanent
+		property :title, String, required: true
+		property :description, Text
+	end
+
+**Integration note**: You can still delete permanent models with
+[`#destroy!`](http://rubydoc.info/github/datamapper/dm-core/master/DataMapper/Resource#destroy%21-instance_method).
+In general, make a practice out of staying away from DataMapper's unsafe bang
+(!) methods.  These
+[bang methods don't run validators or callbacks](http://datamapper.org/docs/create_and_destroy.html).
+:-(
+
+### Searchable Model
+
+This mixin duct tapes your class together with
+[Sunspot](http://sunspot.github.io/) and
+[Solr](https://lucene.apache.org/solr/), and makes your class's resources
+indexed and searchable.  It's meant to be used in conjunction with the
+[normal model](#normal-model) mixin.
+
+**Rationale**: Everyone loves full-text search, and this makes it easy to get
+DataMapper to talk to Sunspot.  Include this mixin, define your model, then
+use
+[Sunspot's powerful DSL](http://sunspot.github.io/docs/index.html#Indexing_In_Depth)
+to define what should be indexed and how it should be weighted.
+
+	require 'data_mapped/model'
+	require 'data_mapped/searchable'
+	
+	class Movie
+		include DataMapped::Model
+		include DataMapped::Searchable
+		property :title, String, required: true
+		property :description, Text
+		has n, :actors, through: Resource
+		
+		searchable auto_index: true, auto_remove: true do
+			text :title, boost: 2.0
+			text :description
+			text :actor_names, boost: 1.5 do
+				self.actors.map(&:name).join(', ')
+			end
+		end
+	end
+	
+	class Actor
+		include DataMapped::Model
+		property :name, String, required: true
+		has n, :movies, through: Resource
+	end
+
+
 
 ## Contributing
 

data/data_mapped.gemspec

@@ -6,11 +6,11 @@ require 'data_mapped/version'
 Gem::Specification.new do |spec|
   spec.name          = "data_mapped"
   spec.version       = DataMapped::VERSION
-  spec.authors       = ["Raj Shah"]
+  spec.authors       = ["Rajiv Bakulesh Shah"]
   spec.email         = ["brainix@gmail.com"]
-  spec.description   = %q{Helpful mixins for DataMapper}
-  spec.summary       = %q{Helpful mixins for DataMapper}
-  spec.homepage      = ""
+  spec.description   = %q{Mixins for DataMapper}
+  spec.summary       = %q{Mixins for DataMapper}
+  spec.homepage      = "https://github.com/brainix/data_mapped"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/lib/data_mapped/join.rb

@@ -1,3 +1,11 @@
+#-----------------------------------------------------------------------------#
+#   join.rb                                                                   #
+#                                                                             #
+#   Copyright (c) 2013, Rajiv Bakulesh Shah.                                  #
+#-----------------------------------------------------------------------------#
+
+
+
 require 'data_mapper'
 
 

data/lib/data_mapped/model.rb

@@ -1,3 +1,11 @@
+#-----------------------------------------------------------------------------#
+#   model.rb                                                                  #
+#                                                                             #
+#   Copyright (c) 2013, Rajiv Bakulesh Shah.                                  #
+#-----------------------------------------------------------------------------#
+
+
+
 require 'data_mapper'
 
 

data/lib/data_mapped/permanent.rb

@@ -1,3 +1,11 @@
+#-----------------------------------------------------------------------------#
+#   permanent.rb                                                              #
+#                                                                             #
+#   Copyright (c) 2013, Rajiv Bakulesh Shah.                                  #
+#-----------------------------------------------------------------------------#
+
+
+
 require 'data_mapper'
 
 
@@ -15,9 +23,7 @@ module DataMapped
     DataMapper::Model.append_inclusions(InstanceMethods)
 
     def self.included(other)
-      other.class_eval do
-        before :destroy, :vomit_before_destruction
-      end
+      other.class_eval { before :destroy, :vomit_before_destruction }
     end
 
   end

data/lib/data_mapped/searchable.rb

@@ -1,3 +1,11 @@
+#-----------------------------------------------------------------------------#
+#   searchable.rb                                                             #
+#                                                                             #
+#   Copyright (c) 2013, Rajiv Bakulesh Shah.                                  #
+#-----------------------------------------------------------------------------#
+
+
+
 require 'active_support/all'
 require 'data_mapper'
 require 'sunspot'
@@ -25,7 +33,11 @@ module DataMapped
     end
 
     def self.included(other)
-      other.class_eval { alias_method(:new_record?, :new?) }
+      other.class_eval do
+        alias_method(:new_record?, :new?)
+        after :save, :reindex
+        after :destroy, :reindex
+      end
       other.extend Sunspot::Rails::Searchable::ActsAsMethods
       Sunspot::Adapters::DataAccessor.register(DataAccessor, other)
       Sunspot::Adapters::InstanceAdapter.register(InstanceAdapter, other)

data/lib/data_mapped/version.rb

@@ -1,3 +1,3 @@
 module DataMapped
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: data_mapped
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
-- Raj Shah
+- Rajiv Bakulesh Shah
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-03 00:00:00.000000000 Z
+date: 2013-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,7 +108,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.3.3
-description: Helpful mixins for DataMapper
+description: Mixins for DataMapper
 email:
 - brainix@gmail.com
 executables: []
@@ -129,7 +129,7 @@ files:
 - lib/data_mapped/permanent.rb
 - lib/data_mapped/searchable.rb
 - lib/data_mapped/version.rb
-homepage: ''
+homepage: https://github.com/brainix/data_mapped
 licenses:
 - MIT
 metadata: {}
@@ -152,5 +152,5 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: Helpful mixins for DataMapper
+summary: Mixins for DataMapper
 test_files: []