post_json 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5fb855c51537275da0a59cfda2e1b80bc13a257
-  data.tar.gz: 4088ddc01020461837ff1b1bfd044c5c1426ed33
+  metadata.gz: 96d7ef19a5b074957629924c45a9a71894cc5f97
+  data.tar.gz: ca189492fea7bf032db65d2762c852b66c39532b
 SHA512:
-  metadata.gz: e5ce9111121f57bd4cbe74ec3bf9ba43704469bbc585abcc004894d47b243749a39cab7744de50d5b389e79c1013116258f418cc53efe5db1054aeb13ca0cad9
-  data.tar.gz: 6f27d38837491b0cbb3c5e4acf410c52066bdc6f4dbbed8893aae6886b5c22a401497ed8a7cb2cefb79da705fda3244446e84fc65c7fd2635bbca4d69c902793
+  metadata.gz: 263da488e04ee6c7dc08aaaed72d21c0802bc3d6ec96aa5575e0519c8945c72c31f20c346e432eaa182cfe8b1b964f5bcd0eeacdca7f02b3d693606ae73cc8d1
+  data.tar.gz: b3a221adbf2b1b67c810a0c0b7c76c942ff4f68dc3a3234e75557a7006c07ce49be538560218884085f94ff08e8108a8050464cee7e6b1b35cee78c7edf6d389

data/MIT-LICENSE

@@ -17,4 +17,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -7,7 +7,7 @@ PostJson take full advantage of PostgreSQL 9.2+ support for JavaScript (Google's
 PostJson, because we love document databases and PostgreSQL. PostJson combine features of Ruby, ActiveRecord and 
 PostgreSQL to provide a great document database.
 
-See example of how we use PostJson as part of Jump... 
+See example of how we use PostJson as part of <a href="https://github.com/webnuts/jumpstarter">Jumpstarter</a>.
 
 
 ## Getting started
@@ -105,61 +105,43 @@ Also, __notice you don't have to define model attributes anywhere!__
         
     Like you would expect with ActiveRecord.
 
-#### All of the following methods are supported
+5. Introduction to select and selectors.
 
-        except
-        limit
-        offset
-        page(page, per_page) # translate to `offset((page-1)*per_page).limit(per_page)`
-        only
-        order
-        reorder
-        reverse_order
-        where
-        
-    And ...
-        
-        all
-        any?
-        blank?
-        count
-        delete
-        delete_all
-        destroy
-        destroy_all
-        empty?
-        exists?
-        find
-        find_by
-        find_by!
-        find_each
-        find_in_batches
-        first
-        first!
-        first_or_create
-        first_or_initialize
-        ids
-        last
-        load
-        many?
-        pluck
-        select
-        size
-        take
-        take!
-        to_a
-        to_sql
-        
-        
-        
-        
+    Sometimes we need a transformed version of documents. This is very easy with `select`
 
+        me = Person.create(name: "Jacob", details: {age: 33})
+
+        other_me = Person.limit(1).select({name: "name", age: "details.age"}).first
+        puts other_me               # {name: "Jacob", age: 33}
+
+    `select` takes a hash as argument and return an array of hashes. The value of each key/value pair in the hash argument is a selector. Selectors can point at attributes at root level, but also nested attributes. Each level of attributes is seperated with a dot (.).
+
+6. Check out the initializer at `config/initializers/post_json.rb`
+
+        PostJson.setup "people" do |collection|
+          collection.record_timestamps = true                           # default is 'true'
+          collection.created_at_attribute_name = "created_at"           # default is 'created_at'
+          collection.updated_at_attribute_name = "updated_at"           # default is 'updated_at'
+          collection.include_version_number = true                      # default is 'true'
+          collection.version_attribute_name = "version"                 # default is 'version'
+          collection.use_dynamic_index = true                           # default is 'true'
+          collection.create_dynamic_index_milliseconds_threshold = 50   # default is '50'
+        end
+
+#### All of the following methods are supported
 
+all, any?, blank?, count, delete, delete_all, destroy, destroy_all, each, empty?, except, exists?, find, find_by, 
+find_by!, find_each, find_in_batches, first, first!, first_or_create, first_or_initialize, ids, last, limit, load, 
+many?, offset, only, order, pluck, reorder, reverse_order, select, size, take, take!, to_a, to_sql, and where.
+        
+We also added `page(page, per_page)`, which translate into `offset((page-1)*per_page).limit(per_page)`.
         
 ## Dynamic Indexes
 
-We have created a feature we call `Dynamic Index`. It will automatically create indexes on slow queries, so queries 
-speed up considerably.
+Most applications do the same queries over and over again. This is why we think it is useful, if PostJson create indexes on slow queries.
+
+So we have created a feature we call `Dynamic Index`. It will automatically create indexes on slow queries, 
+so queries speed up considerably.
 
 PostJson will measure the duration of each `SELECT` query and instruct PostgreSQL to create an Index, 
 if the query duration is above a specified threshold.
@@ -174,6 +156,38 @@ Lets say that you execute the following query and the duration is above the thre
 PostJson will create (unless it already exists) an Index on `name` behind the scenes. The next time 
 you execute a query with `name` the performance will be much improved.
 
+You can adjust the settings:
+
+        class Person < PostJson::Collection["people"]
+          self.create_dynamic_index_milliseconds_threshold = 75
+        end
+
+        # Or you can do:
+
+        PostJson::Collection["people"].create_dynamic_index_milliseconds_threshold = 75
+
+        # Now indexes are only created if queries are slower than 75 milliseconds.
+
+
+You might already know this about User Interfaces, but it is usual considered good practice if auto-complete responses are served to the user within 100 milliseconds. Other results are usual okay within 500 milliseconds. So leave room for application processing and network delay.
+
+Do not set create_dynamic_index_milliseconds_threshold too low as PostJson will try to create an index for every query performance. Like a threshold of 1 millisecond will be less than almost all query durations.
+
+## The future
+
+A few things we will be working on:
+- Versioning of documents with support for history, restore and rollback.
+- Restore a copy of entire collection at a specific date.
+- Copy a collection.
+- Automatic deletion of dynamic indexes when unused for a period of time.
+- Full text search. PostgreSQL has many great features.
+- Bulk import.
+- Support for files. Maybe as attachments to documents.
+- Keep the similarities with ActiveRecord API, but it shouldn't depend on Rails or ActiveRecord. 
+- Better performance and less complex code.
+
+And please let us know what you think and what you need. 
+
 ## Requirements
 
 - PostgreSQL 9.2 or 9.3
@@ -187,7 +201,7 @@ PostJson is released under the MIT License. See the MIT-LICENSE file.
 
 That's awesome, thank you!
 
-Do you have an idea or suggestion? Please create an issue or send us an e-mail (hello@webnuts.com). We would be happy to implement (if we like the idea) right away.
+Do you have an idea or suggestion? Please create an issue or send us an e-mail (hello@webnuts.com). We would be happy to implement right away.
 
 You can also send us a pull request with your contribution.
 

data/Rakefile

@@ -18,4 +18,3 @@ end
 
 
 Bundler::GemHelper.install_tasks
-

data/lib/generators/post_json/install/templates/initializer.rb

@@ -1,3 +1,5 @@
+require 'post_json'
+
 # PostJson.setup "people" do |collection|
 #   collection.record_timestamps = true                           # default is 'true'
 #   collection.created_at_attribute_name = "created_at"           # default is 'created_at'

data/lib/post_json.rb

@@ -53,4 +53,4 @@ module PostJson
       end
     end
   end
-end
+end

data/lib/post_json/base.rb

@@ -1,3 +1,6 @@
+# Why all the ugly naming you might ask? Well, it will be fixed,
+# but for now it is preventing a conflict with the naming of JSON attributes
+
 module PostJson
   class Base < ActiveRecord::Base
     self.abstract_class = true

data/lib/post_json/version.rb

@@ -1,3 +1,3 @@
 module PostJson
-  VERSION = "1.0.5"
+  VERSION = "1.0.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: post_json
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Jacob Madsen and Martin Thoegersen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-18 00:00:00.000000000 Z
+date: 2013-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails