arunthampi-friendly 0.5.1

data/.document

@@ -0,0 +1,2 @@
+README.md
+lib/**/*.rb

data/.gitignore

@@ -0,0 +1,26 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+test.rb
+test_active_record.rb
+spec/config.yml
+.yardoc
+doc

data/APACHE-LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+Changelog
+=========
+
+### 0.5
+  
+  * (jamesgolick) Add offline index building.
+
+### 0.4.4
+
+  * (jamesgolick) Make it possible to query with order, but no conditions.
+  * (jamesgolick) Add change tracking. This is mostly to facilitate arbitrary caches.
+
+### 0.4.2
+
+  * (nullstyle) convert UUID to SQL::Blob so that Sequel can properly escape it in databases that don't treat binary strings like regular strings.
+
+### 0.4.1
+
+  * (jamesgolick) Fix for ruby 1.9.1.
+
+### 0.4.0
+
+  * (jamesgolick) Add scope chaining. See the README and the docs for Friendly::Scope.
+  * (jamesgolick) Add has_many association.
+  * (jamesgolick) Add ad-hoc scopes. See the docs for Document.scope.
+  * (jamesgolick) Add named_scope functionality. See the docs for Document.named_scope.
+  * (jeffrafter + jamesgolick) DDL generation now supports custom types. Previously, it would only work with types that Sequel already supported. Now, if you want to register a custom type, use Friendly::Attribute.register_type(klass, sql_type, &conversion_method).
+

data/CONTRIBUTORS.md

@@ -0,0 +1,7 @@
+Contributors to Friendly
+========================
+
+  * James Golick        - http://jamesgolick.com (github: jamesgolick)
+  * Jonathan Palardy    - http://technotales.wordpress.com (github: jpalardy)
+  * Jeff Rafter         - http://socialorange.com (github: jeffrafter)
+  * Scott Fleckenstein  - http://nullstyle.com (github: nullstyle)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 James Golick
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/README.md

@@ -0,0 +1,288 @@
+Friendly
+========
+
+### Short Version
+
+This is an implementation of the ideas found in [this article](http://bret.appspot.com/entry/how-friendfeed-uses-mysql) about how FriendFeed uses MySQL. You should read that article for all the details.
+
+### Long Version
+
+Turn MySQL in to a document db!
+
+Why? Everybody is super excited about NoSQL. Aside from the ridiculous rumour that removing SQL makes things magically scalable, there's a lot of reason to look forward to these new data storage solutions.
+
+One of the biggest improvements is where schema / index changes are concerned. When you have a ton of data, migrating MySQL tables takes forever and locks the table during the process. Document dbs like mongo and couch, on the other hand, are schemaless. You just add and remove fields as you need them.
+
+But, the available document oriented solutions are still young. While many of them show great promise, they've all got their quirks. For all its flaws, MySQL is a rock. It's pretty fast, and battle-hardened. We *never* have problems with MySQL in production.
+
+Fortunately, with a little extra work on the client-side, we can get the flexibility of a doc db in MySQL!
+
+### How it Works
+
+Let's say we had a user model.
+
+    class User
+      include Friendly::Document
+
+      attribute :name, String
+      attribute :age,  Integer
+    end
+
+Friendly always stores your documents in a table with the same schema:
+
+    CREATE TABLE users (
+        added_id INT NOT NULL AUTO_INCREMENT PRIMARY KEY,
+        id BINARY(16) NOT NULL,
+        created_at DATETIME NOT NULL,
+        updated_at DATETIME NOT NULL,
+        attributes TEXT,
+        UNIQUE KEY (id),
+    ) ENGINE=InnoDB;
+
+  - added_id is there because InnoDB stores records on disk in sequential primary key order. Having recently inserted objects together on disk is usually a win.
+  - id is a UUID (instance of Friendly::UUID).
+  - created_at and updated_at are exactly what they sound like - automatically managed by Friendly.
+  - attributes is where all the attributes of your object are stored. They get serialized to json and stored in there.
+
+We can instantiate and save our model like an ActiveRecord object.
+
+    @user = User.new :name => "James"
+    @user.save
+
+As is, our user model only supports queries by id.
+
+    User.find(id)
+    User.first(:id => id)
+    User.all(:id => [1,2,3])
+
+Not great. We'd probably want to be able to query by name, at the very least.
+
+Indexes
+=======
+
+To support richer queries, Friendly maintains its own indexes in separate tables. To index our user model on name, we'd create a table like this:
+
+    CREATE TABLE index_users_on_name (
+      name varchar(256) NOT NULL,
+      id binary(16) NOT NULL,
+      PRIMARY KEY (name, id)
+      UNIQUE KEY unique_index_on_id (id)
+    ) ENGINE=InnoDB DEFAULT CHARSET=latin1
+
+Then, we'd tell friendly to maintain that index for us:
+
+    class User
+      # ... snip ...
+
+      indexes :name
+    end
+
+Any time friendly saves a user object, it will update the index as well. That way, we can query by name:
+
+    User.first(:name => "James")
+    User.all(:name => ["James", "John", "Jonathan"])
+
+One of the big advantages to this approach is that indexes can be built offline. If you need a new index, you can write a script to generate it in the background without affecting the running application. Then, once it's ready, you can start querying it.
+
+Caching
+=======
+
+Friendly has built-in support for write-through caching.
+
+First, install the memcached gem:
+
+    sudo gem install memcached
+
+Then, configure your cache:
+
+    $cache         = Memcached.new # you'll probably want to pass some params here.
+    Friendly.cache = Friendly::Memcached.new($cache)
+
+Finally, declare the cache in your model:
+
+    class User
+      # ... snip ...
+
+      caches_by :id
+    end
+
+This tells Friendly to automatically write through to cache on save, and read through to the cache if it needs to hit the database on a query.
+
+Currently, only caching by id is supported, but caching of arbitrary indexes is planned. 
+
+__We're seeing a 99.8% cache hit rate in production with this code.__
+
+Scopes
+======
+
+### Named Scopes
+
+It's possible to create a scope that you can refer to by name:
+
+    class Post
+      attribute :author, String
+
+      named_scope :by_james, :author => "James"
+    end
+
+Calling the scope will provide you with a Friendly:Scope object:
+
+    Post.by_james #=> #<Friendly::Scope>
+
+That scope object supports a variety of methods. Calling any of the methods is the equivalent of calling those methods directly on Document with the scope's parameters.
+
+  e.g.
+
+    Post.by_james.all == Post.all(:author => "James")
+    Post.by_james.first == Post.first(:author => "James")
+    Post.by_james.paginate # => #<WillPaginate::Collection>
+    Post.by_james.build.name == "James"
+    @post = Post.by_james.create
+    @post.new_record? # => false
+    @post.name # => "James"
+
+Each of the methods also accepts override parameters. The APIs are the same as on Document.
+
+    Post.by_james.all(:author => "Steve") == Post.all(:author => "Steve")
+
+You can also compose arbitrary combinations of scopes with simple chaining.
+    
+    class Post
+      # ... snip ...
+      named_scope :recent, :order! => :created_at.desc, :limit! => 4
+      indexes     :name, :created_at
+    end
+
+    Post.by_james.recent == Post.all(:name   => "James", 
+                                     :order! => :created_at.desc, 
+                                     :limit!  => 4)
+
+If two parameters conflict, the right-most scope takes precedence.
+
+### Ad-hoc Scopes
+
+You can also create a scope object on the fly:
+
+    Post.scope(:author => "Steve")
+    
+The object you get is identical to the one you get from a named_scope. So, see above for the API.
+
+Associations
+============
+
+Friendly currently only supports has\_many associations. 
+
+Creating a has\_many is as simple as setting up the necessary association and foreign key.
+
+_Note: Make sure that the target model is indexed on the foreign key. If it isn't, querying the association will raise Friendly::MissingIndex._
+
+e.g.
+
+    class Post
+      attribute :user_id, Friendly::UUID
+      indexes   :user_id
+    end
+     
+    class User
+      has_many :posts
+    end
+    
+    @user = User.create
+    @post = @user.posts.create
+    @user.posts.all == [@post] # => true
+
+Friendly defaults the foreign key to class_name_id just like ActiveRecord. It also converts the name of the association to the name of the target class just like ActiveRecord does.
+
+The biggest difference in semantics between Friendly's has\_many and active\_record's is that Friendly's just returns a Friendly::Scope object. If you want all the associated objects, you have to call #all to get them. 
+
+You can also use any other Friendly::Scope method like scope chaining.
+
+    # note: the Post.recent scope is defined in the above section
+    @user.posts.recent == Post.all(:user_id => @user.id,
+                                   :order!  => :created_at.desc, 
+                                   :limit!  => 4)
+
+See the section above or the Friendly::Scope docs for more details.
+
+Offline Indexing
+================
+
+Friendly includes support for building an index in the background, without taking your app offline.
+
+All you have to do is declare the index in your model. If we wanted to add an index on :name, :created_at in a User model, we'd do it like this:
+
+    class User
+      # ...snip...
+
+      indexes :name, :created_at
+    end
+
+Then, make sure to run Friendly.create_tables! to create the table in the database. This won't overwrite any of your existing tables, so don't worry.
+
+    >> Friendly.create_tables!
+
+Now that the the new table has been created, you need to copy the .rake file included with Friendly (lib/tasks/friendly.rake) to somewhere that will get picked up by your main Rakefile (lib/tasks if it's a rails project). Then, run:
+
+    $ KLASS=User FIELDS=name,created_at rake friendly:build_index
+
+If you're running this in production, you'll probably want to fire up GNU screen so that it'll keep running even if you lose your SSH connection. When this task completes, the index is populated and ready to go!
+
+Installation
+============
+
+Friendly is available as a gem. Get it with:
+
+    sudo gem install friendly
+
+Setup
+=====
+
+All you have to do is supply Friendly with some information about your database:
+
+    Friendly.configure :adapter  => "mysql",
+                       :host     => "localhost",
+                       :user     => "root",
+                       :password => "swordfish",
+                       :database => "friendly_development"
+
+Now, you're ready to rock.
+
+If you're using rails, set friendly as a gem dependency:
+
+    config.gem "friendly"
+
+...and drop something like this in config/friendly.yml (an example of such a config exists in examples/friendly.yml):
+
+    development:
+      :adapter:  "mysql"
+      :host:     "localhost"
+      :user:     "root"
+      :password: "swordfish"
+      :database: "friendly_development"
+
+Of course, you'll want to swap out these values for your own, fill in additional environments, and so forth.
+
+Then, create some models, and run:
+
+    Friendly.create_tables!
+
+That'll create all the necessary tables as best it can. This has worked well enough for me, but it's possible that certain table configurations will fail. It won't attempt to create any tables that already exist, so it's safe to run in an initializer or something.
+
+TODO
+====
+
+  - Online migrations. Add a version column to each model and a DSL to update schema from one version to another on read. This facilitates data transformations on the fly. If you want to transform the whole table at once, just iterate over all the objects, and save.
+  - Associations
+  - Offline indexer
+  - Caching of arbitrary indexes
+  - A lot more documentation
+
+Credits
+=======
+
+Friendly was developed by James Golick & Jonathan Palardy at FetLife (nsfw).
+
+Copyright (c) 2009 James Golick. See LICENSE for details.
+
+Except for friendly/uuid.rb which is copyright Evan Weaver and Apache Licensed. See APACHE-LICENSE for details.
+