couchbase-model 0.0.1 → 0.1.0

data/lib/couchbase/model/configuration.rb

@@ -0,0 +1,30 @@
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+module Couchbase
+
+  class Model
+
+    module Configuration
+      extend self
+
+      attr_accessor :design_documents_paths
+    end
+
+  end
+
+end

data/lib/couchbase/model/uuid.rb

@@ -23,15 +23,23 @@ module Couchbase
 
     # Generator of CouchDB specfic UUIDs. This is the ruby implementation of
     # couch_uuids.erl from couchdb distribution. It is threadsafe.
+    #
+    # @since 0.0.1
 
     class UUID
       # Get default UUID generator. You can create your own if you like.
+      #
+      # @since 0.0.1
+      #
+      # @return [UUID]
       def self.generator
         @generator ||= UUID.new
       end
 
       # Initialize generator.
       #
+      # @since 0.0.1
+      #
       # @param [Fixnum] seed seed for pseudorandom number generator.
       def initialize(seed = nil)
         seed ? srand(seed) : srand
@@ -42,6 +50,8 @@ module Couchbase
 
       # Generate list of UUIDs.
       #
+      # @since 0.0.1
+      #
       # @param [Fixnum] count number of UUIDs you need
       #
       # @param [Symbol] algorithm Algorithm to use. Known algorithms:

data/lib/couchbase/model/version.rb

@@ -19,7 +19,7 @@ module Couchbase
 
   class Model
 
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
 
   end
 

data/lib/couchbase/railtie.rb

@@ -0,0 +1,136 @@
+# encoding: utf-8
+#
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+require 'couchbase/model'
+
+module Rails #:nodoc:
+  module Couchbase #:nodoc:
+    class Railtie < Rails::Railtie #:nodoc:
+
+      # Determine which generator to use. app_generators was introduced after
+      # 3.0.0.
+      #
+      # @since 0.1.0
+      #
+      # @example Get the generators method.
+      #   railtie.generators
+      #
+      # @return [Symbol] The method name to use.
+      def self.generator
+        config.respond_to?(:app_generators) ? :app_generators : :generators
+      end
+
+      # Maping of rescued exceptions to HTTP responses
+      #
+      # @since 0.1.0
+      #
+      # @example
+      #   railtie.rescue_responses
+      #
+      # @return [Hash] rescued responses
+      def self.rescue_responses
+        {
+          "Couchbase::Error::NotFound" => :not_found,
+          "Couchbase::Error::NotStored" => :unprocessable_entity
+        }
+      end
+
+      config.send(generator).orm :couchbase, :migration => false
+
+      if config.action_dispatch.rescue_responses
+        config.action_dispatch.rescue_responses.merge!(rescue_responses)
+      end
+
+      # Initialize Couchbase Mode. This will look for a couchbase.yml in the
+      # config directory and configure Couchbase connection appropriately.
+      #
+      # @example couchbase.yml
+      #
+      #   common: &common
+      #     hostname: localhost
+      #     port: 8091
+      #     username:
+      #     password:
+      #     pool: default
+      #
+      #   production:
+      #     <<: *common
+      #     bucket: example_production
+      #
+      #   test:
+      #     <<: *common
+      #     bucket: example_test
+      #
+      #   development:
+      #     <<: *common
+      #     bucket: example_development
+      #
+      initializer "couchbase.setup_connection" do
+        config_file = Rails.root.join("config", "couchbase.yml")
+        if config_file.file? &&
+          config = YAML.load(ERB.new(File.read(config_file)).result)[Rails.env]
+          ::Couchbase.connection_options = config.with_indifferent_access
+        end
+      end
+
+      # After initialization we will warn the user if we can't find a couchbase.yml and
+      # alert to create one.
+      initializer "couchbase.warn_configuration_missing" do
+        unless ARGV.include?("couchbase:config")
+          config.after_initialize do
+            unless Rails.root.join("config", "couchbase.yml").file?
+              puts "\nCouchbase config not found. Create a config file at: config/couchbase.yml"
+              puts "to generate one run: rails generate couchbase:config\n\n"
+            end
+          end
+        end
+      end
+
+      # Check (and upgrade if needed) all design documents
+      initializer "couchbase.upgrade_design_documents", :after =>"couchbase.setup_connection"  do |app|
+        config.to_prepare do
+          ::Couchbase::Model::Configuration.design_documents_paths ||= app.config.paths["app/models"]
+          app.config.paths["app/models"].each do |path|
+            Dir.glob("#{path}/**/*.rb").sort.each do |file|
+              require_dependency(file.gsub("#{path}/" , "").gsub(".rb", ""))
+            end
+          end
+          begin
+            ::Couchbase::Model.descendants.each do |model|
+              model.ensure_design_document!
+            end
+          rescue ::Couchbase::Error::Timeout, ::Couchbase::Error::Connect
+            # skip connection errors for now
+          end
+        end
+      end
+
+      # Set the proper error types for Rails. NotFound errors should be
+      # 404s and not 500s, validation errors are 422s.
+      initializer "couchbase.load_http_errors" do |app|
+        config.after_initialize do
+          unless config.action_dispatch.rescue_responses
+            ActionDispatch::ShowExceptions.rescue_responses.update(Railtie.rescue_responses)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/rails/generators/couchbase/config/config_generator.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+#
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+require 'rails/generators/couchbase_generator'
+
+module Couchbase
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      desc "Creates a Couchbase configuration file at config/couchbase.yml"
+
+      argument :database_name, :type => :string, :optional => true
+
+      def self.source_root
+        @_couchbase_source_root ||= File.expand_path("../templates", __FILE__)
+      end
+
+      def app_name
+        Rails::Application.subclasses.first.parent.to_s.underscore
+      end
+
+      def create_config_file
+        template 'couchbase.yml', File.join('config', "couchbase.yml")
+      end
+
+    end
+  end
+end

data/lib/rails/generators/couchbase/config/templates/couchbase.yml

@@ -0,0 +1,23 @@
+common: &common
+  hostname: localhost
+  port: 8091
+  username:
+  password:
+  pool: default
+
+development:
+  <<: *common
+  bucket: <%= database_name || app_name %>_development
+
+test:
+  <<: *common
+  bucket: <%= database_name || app_name %>_test
+
+# set these environment variables on your production server
+production:
+  hostname: <%%= ENV['COUCHBASE_HOST'] %>
+  port: <%%= ENV['COUCHBASE_PORT'] %>
+  username: <%%= ENV['COUCHBASE_USERNAME'] %>
+  password: <%%= ENV['COUCHBASE_PASSWORD'] %>
+  pool: <%%= ENV['COUCHBASE_POOL'] %>
+  bucket: <%%= ENV['COUCHBASE_BUCKET'] %>

data/lib/rails/generators/couchbase/view/templates/map.js

@@ -0,0 +1,40 @@
+// The map function is the most critical part of any view as it provides the
+// logical mapping between the input fields of the individual objects stored
+// within Couchbase to the information output when the view is accessed.
+//
+// Read more about how to write map functions at:
+// http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-views-writing-map.html
+
+function(doc) {
+  emit(doc._id, null);
+}
+
+// You can also check out following examples
+//
+// The simplest example of a map function:
+//
+//   function(doc) {
+//     emit(doc._id, doc);
+//   }
+//
+// Slightly more complex example of a function that defines a view on values
+// computed from customer documents:
+//
+//   function(doc) {
+//     if (doc.type == "customer") {
+//       emit(doc._id, {last_name: doc.last_name, first_name: doc.first_name});
+//     }
+//   }
+//
+// To be able to filter or sort the view by some document property, you
+// would use that property for the key. For example, the following view
+// would allow you to lookup customer documents by the last_name or
+// first_name fields (your keys could be compound, e.g. arrays):
+//
+//   function(doc) {
+//     if (doc.type == "customer") {
+//       emit(doc.last_name, {first_name: doc.first_name});
+//       emit(doc.first_name, {last_name: doc.last_name});
+//     }
+//   }
+//

data/lib/rails/generators/couchbase/view/templates/reduce.js

@@ -0,0 +1,61 @@
+// If a view has a reduce function, it is used to produce aggregate results
+// for that view. A reduce function is passed a set of intermediate values
+// and combines them to a single value. Reduce functions must accept, as
+// input, results emitted by its corresponding map function as well as
+// results returned by the reduce function itself. The latter case is
+// referred to as a rereduce.
+//
+//   function (key, values, rereduce) {
+//     return sum(values);
+//   }
+//
+// Reduce functions must handle two cases:
+//
+// 1. When rereduce is false:
+//
+//   reduce([ [key1,id1], [key2,id2], [key3,id3] ], [value1,value2,value3], false)
+//
+//   * key will be an array whose elements are arrays of the form [key,id],
+//     where key is a key emitted by the map function and id is that of the
+//     document from which the key was generated.
+//   * values will be an array of the values emitted for the respective
+//     elements in keys
+//
+// 2. When rereduce is true:
+//
+//   reduce(null, [intermediate1,intermediate2,intermediate3], true)
+//
+//   * key will be null
+//   * values will be an array of values returned by previous calls to the
+//     reduce function
+//
+// Reduce functions should return a single value, suitable for both the
+// value field of the final view and as a member of the values array passed
+// to the reduce function.
+//
+// NOTE: If this file is empty, reduce part will be skipped in design document
+//
+// There is number of built-in functions, which could be used instead of
+// javascript implementation of reduce function.
+//
+// The _count function provides a simple count of the input rows from the
+// map function, using the keys and group level to provide to provide a
+// count of the correlated items. The values generated during the map()
+// stage are ignored.
+//
+//   _count
+//
+// The built-in _sum function collates the output from the map function
+// call. The information can either be a single number or an array of numbers.
+//
+//   _sum
+//
+// The _stats built-in produces statistical calculations for the input data.
+// Like the _sum call the source information should be a number. The
+// generated statistics include the sum, count, minimum (min), maximum (max)
+// and sum squared (sumsqr) of the input rows.
+//
+//   _stats
+//
+// Read more about how to write reduce functions at:
+// http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-views-writing-reduce.html

data/lib/rails/generators/couchbase/view/view_generator.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+#
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+require 'rails/generators/couchbase_generator'
+
+module Couchbase
+  module Generators
+    class ViewGenerator < Rails::Generators::Base
+      desc "Creates a Couchbase views skeletons for map/reduce functions"
+
+      argument :model_name, :type => :string
+      argument :view_name, :type => :string
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def app_name
+        Rails::Application.subclasses.first.parent.to_s.underscore
+      end
+
+      def create_map_reduce_files
+        template 'map.js', File.join('app', 'models', model_name, view_name, 'map.js')
+        template 'reduce.js', File.join('app', 'models', model_name, view_name, 'reduce.js')
+      end
+
+    end
+  end
+end

data/lib/rails/generators/couchbase_generator.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+#
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+require "rails/generators/named_base"
+require "rails/generators/active_model"
+
+module Couchbase #:nodoc:
+  module Generators #:nodoc:
+
+    class Base < ::Rails::Generators::NamedBase #:nodoc:
+
+      def self.source_root
+        @_couchbase_source_root ||=
+          File.expand_path("../#{base_name}/#{generator_name}/templates", __FILE__)
+      end
+
+      unless methods.include?(:module_namespacing)
+        def module_namespacing(&block)
+          yield if block
+        end
+      end
+
+    end
+
+  end
+end