peleteiro-activecouch 0.2.1

data/lib/active_couch/support/inflections.rb

@@ -0,0 +1,52 @@
+ActiveCouch::Inflector.inflections do |inflect|
+  inflect.plural(/$/, 's')
+  inflect.plural(/s$/i, 's')
+  inflect.plural(/(ax|test)is$/i, '\1es')
+  inflect.plural(/(octop|vir)us$/i, '\1i')
+  inflect.plural(/(alias|status)$/i, '\1es')
+  inflect.plural(/(bu)s$/i, '\1ses')
+  inflect.plural(/(buffal|tomat)o$/i, '\1oes')
+  inflect.plural(/([ti])um$/i, '\1a')
+  inflect.plural(/sis$/i, 'ses')
+  inflect.plural(/(?:([^f])fe|([lr])f)$/i, '\1\2ves')
+  inflect.plural(/(hive)$/i, '\1s')
+  inflect.plural(/([^aeiouy]|qu)y$/i, '\1ies')
+  inflect.plural(/(x|ch|ss|sh)$/i, '\1es')
+  inflect.plural(/(matr|vert|ind)ix|ex$/i, '\1ices')
+  inflect.plural(/([m|l])ouse$/i, '\1ice')
+  inflect.plural(/^(ox)$/i, '\1en')
+  inflect.plural(/(quiz)$/i, '\1zes')
+
+  inflect.singular(/s$/i, '')
+  inflect.singular(/(n)ews$/i, '\1ews')
+  inflect.singular(/([ti])a$/i, '\1um')
+  inflect.singular(/((a)naly|(b)a|(d)iagno|(p)arenthe|(p)rogno|(s)ynop|(t)he)ses$/i, '\1\2sis')
+  inflect.singular(/(^analy)ses$/i, '\1sis')
+  inflect.singular(/([^f])ves$/i, '\1fe')
+  inflect.singular(/(hive)s$/i, '\1')
+  inflect.singular(/(tive)s$/i, '\1')
+  inflect.singular(/([lr])ves$/i, '\1f')
+  inflect.singular(/([^aeiouy]|qu)ies$/i, '\1y')
+  inflect.singular(/(s)eries$/i, '\1eries')
+  inflect.singular(/(m)ovies$/i, '\1ovie')
+  inflect.singular(/(x|ch|ss|sh)es$/i, '\1')
+  inflect.singular(/([m|l])ice$/i, '\1ouse')
+  inflect.singular(/(bus)es$/i, '\1')
+  inflect.singular(/(o)es$/i, '\1')
+  inflect.singular(/(shoe)s$/i, '\1')
+  inflect.singular(/(cris|ax|test)es$/i, '\1is')
+  inflect.singular(/(octop|vir)i$/i, '\1us')
+  inflect.singular(/(alias|status)es$/i, '\1')
+  inflect.singular(/^(ox)en/i, '\1')
+  inflect.singular(/(vert|ind)ices$/i, '\1ex')
+  inflect.singular(/(matr)ices$/i, '\1ix')
+  inflect.singular(/(quiz)zes$/i, '\1')
+
+  inflect.irregular('person', 'people')
+  inflect.irregular('man', 'men')
+  inflect.irregular('child', 'children')
+  inflect.irregular('sex', 'sexes')
+  inflect.irregular('move', 'moves')
+
+  inflect.uncountable(%w(equipment information rice money species series fish sheep))
+end

data/lib/active_couch/support/inflector.rb

@@ -0,0 +1,279 @@
+# This file is copied from the ActiveSupport project, which
+# is a part of the Ruby On Rails web-framework (http://rubyonrails.org).
+require 'singleton'
+
+# The Inflector transforms words from singular to plural, class names to table names, modularized class names to ones without,
+# and class names to foreign keys. The default inflections for pluralization, singularization, and uncountable words are kept
+# in inflections.rb.
+module ActiveCouch
+  module Inflector
+    # A singleton instance of this class is yielded by Inflector.inflections, which can then be used to specify additional
+    # inflection rules. Examples:
+    #
+    #   Inflector.inflections do |inflect|
+    #     inflect.plural /^(ox)$/i, '\1\2en'
+    #     inflect.singular /^(ox)en/i, '\1'
+    #
+    #     inflect.irregular 'octopus', 'octopi'
+    #
+    #     inflect.uncountable "equipment"
+    #   end
+    #
+    # New rules are added at the top. So in the example above, the irregular rule for octopus will now be the first of the
+    # pluralization and singularization rules that is runs. This guarantees that your rules run before any of the rules that may
+    # already have been loaded.
+    class Inflections
+      include Singleton
+
+      attr_reader :plurals, :singulars, :uncountables
+
+      def initialize
+        @plurals, @singulars, @uncountables = [], [], []
+      end
+
+      # Specifies a new pluralization rule and its replacement. The rule can either be a string or a regular expression.
+      # The replacement should always be a string that may include references to the matched data from the rule.
+      def plural(rule, replacement)
+        @plurals.insert(0, [rule, replacement])
+      end
+
+      # Specifies a new singularization rule and its replacement. The rule can either be a string or a regular expression.
+      # The replacement should always be a string that may include references to the matched data from the rule.
+      def singular(rule, replacement)
+        @singulars.insert(0, [rule, replacement])
+      end
+
+      # Specifies a new irregular that applies to both pluralization and singularization at the same time. This can only be used
+      # for strings, not regular expressions. You simply pass the irregular in singular and plural form.
+      #
+      # Examples:
+      #   irregular 'octopus', 'octopi'
+      #   irregular 'person', 'people'
+      def irregular(singular, plural)
+        plural(Regexp.new("(#{singular[0,1]})#{singular[1..-1]}$", "i"), '\1' + plural[1..-1])
+        singular(Regexp.new("(#{plural[0,1]})#{plural[1..-1]}$", "i"), '\1' + singular[1..-1])
+      end
+
+      # Add uncountable words that shouldn't be attempted inflected.
+      #
+      # Examples:
+      #   uncountable "money"
+      #   uncountable "money", "information"
+      #   uncountable %w( money information rice )
+      def uncountable(*words)
+        (@uncountables << words).flatten!
+      end
+
+      # Clears the loaded inflections within a given scope (default is :all). Give the scope as a symbol of the inflection type,
+      # the options are: :plurals, :singulars, :uncountables
+      #
+      # Examples:
+      #   clear :all
+      #   clear :plurals
+      def clear(scope = :all)
+        case scope
+          when :all
+            @plurals, @singulars, @uncountables = [], [], []
+          else
+            instance_variable_set "@#{scope}", []
+        end
+      end
+    end
+
+    extend self
+
+    def inflections
+      if block_given?
+        yield Inflections.instance
+      else
+        Inflections.instance
+      end
+    end
+
+    # Returns the plural form of the word in the string.
+    #
+    # Examples
+    #   "post".pluralize #=> "posts"
+    #   "octopus".pluralize #=> "octopi"
+    #   "sheep".pluralize #=> "sheep"
+    #   "words".pluralize #=> "words"
+    #   "the blue mailman".pluralize #=> "the blue mailmen"
+    #   "CamelOctopus".pluralize #=> "CamelOctopi"
+    def pluralize(word)
+      result = word.to_s.dup
+
+      if inflections.uncountables.include?(result.downcase)
+        result
+      else
+        inflections.plurals.each { |(rule, replacement)| break if result.gsub!(rule, replacement) }
+        result
+      end
+    end
+
+    # The reverse of pluralize, returns the singular form of a word in a string.
+    #
+    # Examples
+    #   "posts".singularize #=> "post"
+    #   "octopi".singularize #=> "octopus"
+    #   "sheep".singluarize #=> "sheep"
+    #   "word".singluarize #=> "word"
+    #   "the blue mailmen".singularize #=> "the blue mailman"
+    #   "CamelOctopi".singularize #=> "CamelOctopus"
+    def singularize(word)
+      result = word.to_s.dup
+
+      if inflections.uncountables.include?(result.downcase)
+        result
+      else
+        inflections.singulars.each { |(rule, replacement)| break if result.gsub!(rule, replacement) }
+        result
+      end
+    end
+
+    # By default, camelize converts strings to UpperCamelCase. If the argument to camelize
+    # is set to ":lower" then camelize produces lowerCamelCase.
+    #
+    # camelize will also convert '/' to '::' which is useful for converting paths to namespaces
+    #
+    # Examples
+    #   "active_record".camelize #=> "ActiveRecord"
+    #   "active_record".camelize(:lower) #=> "activeRecord"
+    #   "active_record/errors".camelize #=> "ActiveRecord::Errors"
+    #   "active_record/errors".camelize(:lower) #=> "activeRecord::Errors"
+    def camelize(lower_case_and_underscored_word, first_letter_in_uppercase = true)
+      if first_letter_in_uppercase
+        lower_case_and_underscored_word.to_s.gsub(/\/(.?)/) { "::" + $1.upcase }.gsub(/(^|_)(.)/) { $2.upcase }
+      else
+        lower_case_and_underscored_word.first + camelize(lower_case_and_underscored_word)[1..-1]
+      end
+    end
+
+    # Capitalizes all the words and replaces some characters in the string to create
+    # a nicer looking title. Titleize is meant for creating pretty output. It is not
+    # used in the Rails internals.
+    #
+    # titleize is also aliased as as titlecase
+    #
+    # Examples
+    #   "man from the boondocks".titleize #=> "Man From The Boondocks"
+    #   "x-men: the last stand".titleize #=> "X Men: The Last Stand"
+    def titleize(word)
+      humanize(underscore(word)).gsub(/\b([a-z])/) { $1.capitalize }
+    end
+
+    # The reverse of +camelize+. Makes an underscored form from the expression in the string.
+    #
+    # Changes '::' to '/' to convert namespaces to paths.
+    #
+    # Examples
+    #   "ActiveRecord".underscore #=> "active_record"
+    #   "ActiveRecord::Errors".underscore #=> active_record/errors
+    def underscore(camel_cased_word)
+      camel_cased_word.to_s.gsub(/::/, '/').
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr("-", "_").
+        downcase
+    end
+
+    # Replaces underscores with dashes in the string.
+    #
+    # Example
+    #   "puni_puni" #=> "puni-puni"
+    def dasherize(underscored_word)
+      underscored_word.gsub(/_/, '-')
+    end
+
+    # Capitalizes the first word and turns underscores into spaces and strips _id.
+    # Like titleize, this is meant for creating pretty output.
+    #
+    # Examples
+    #   "employee_salary" #=> "Employee salary"
+    #   "author_id" #=> "Author"
+    def humanize(lower_case_and_underscored_word)
+      lower_case_and_underscored_word.to_s.gsub(/_id$/, "").gsub(/_/, " ").capitalize
+    end
+
+    # Removes the module part from the expression in the string
+    #
+    # Examples
+    #   "ActiveRecord::CoreExtensions::String::Inflections".demodulize #=> "Inflections"
+    #   "Inflections".demodulize #=> "Inflections"
+    def demodulize(class_name_in_module)
+      class_name_in_module.to_s.gsub(/^.*::/, '')
+    end
+
+    # Create the name of a table like Rails does for models to table names. This method
+    # uses the pluralize method on the last word in the string.
+    #
+    # Examples
+    #   "RawScaledScorer".tableize #=> "raw_scaled_scorers"
+    #   "egg_and_ham".tableize #=> "egg_and_hams"
+    #   "fancyCategory".tableize #=> "fancy_categories"
+    def tableize(class_name)
+      pluralize(underscore(class_name))
+    end
+
+    # Create a class name from a table name like Rails does for table names to models.
+    # Note that this returns a string and not a Class. (To convert to an actual class
+    # follow classify with constantize.)
+    #
+    # Examples
+    #   "egg_and_hams".classify #=> "EggAndHam"
+    #   "post".classify #=> "Post"
+    def classify(table_name)
+      # strip out any leading schema name
+      camelize(singularize(table_name.to_s.sub(/.*\./, '')))
+    end
+
+    # Creates a foreign key name from a class name.
+    # +separate_class_name_and_id_with_underscore+ sets whether
+    # the method should put '_' between the name and 'id'.
+    #
+    # Examples
+    #   "Message".foreign_key #=> "message_id"
+    #   "Message".foreign_key(false) #=> "messageid"
+    #   "Admin::Post".foreign_key #=> "post_id"
+    def foreign_key(class_name, separate_class_name_and_id_with_underscore = true)
+      underscore(demodulize(class_name)) + (separate_class_name_and_id_with_underscore ? "_id" : "id")
+    end
+
+    # Constantize tries to find a declared constant with the name specified
+    # in the string. It raises a NameError when the name is not in CamelCase
+    # or is not initialized.
+    #
+    # Examples
+    #   "Module".constantize #=> Module
+    #   "Class".constantize #=> Class
+    def constantize(camel_cased_word)
+      unless /\A(?:::)?([A-Z]\w*(?:::[A-Z]\w*)*)\z/ =~ camel_cased_word
+        raise NameError, "#{camel_cased_word.inspect} is not a valid constant name!"
+      end
+
+      Object.module_eval("::#{$1}", __FILE__, __LINE__)
+    end
+
+    # Ordinalize turns a number into an ordinal string used to denote the
+    # position in an ordered sequence such as 1st, 2nd, 3rd, 4th.
+    #
+    # Examples
+    #   ordinalize(1)     # => "1st"
+    #   ordinalize(2)     # => "2nd"
+    #   ordinalize(1002)  # => "1002nd"
+    #   ordinalize(1003)  # => "1003rd"
+    def ordinalize(number)
+      if (11..13).include?(number.to_i % 100)
+        "#{number}th"
+      else
+        case number.to_i % 10
+          when 1: "#{number}st"
+          when 2: "#{number}nd"
+          when 3: "#{number}rd"
+          else    "#{number}th"
+        end
+      end
+    end
+  end
+end
+
+require File.dirname(__FILE__) + '/inflections'

data/lib/active_couch/views.rb

@@ -0,0 +1,3 @@
+require 'active_couch/views/errors'
+require 'active_couch/views/view'
+require 'active_couch/views/raw_view'

data/lib/active_couch/views/errors.rb

@@ -0,0 +1,4 @@
+module ActiveCouch
+  class ViewError < StandardError; end
+  class InvalidFilter < ViewError; end
+end

data/lib/active_couch/views/raw_view.rb

@@ -0,0 +1,40 @@
+require 'json'
+
+module ActiveCouch
+  class RawView
+    class << self # Class Methods
+      # Variables will store Javascript functions which represent
+      # the map/reduce functions respectively
+      @map_function, @reduce_function, @database = nil, nil, nil
+      attr_reader :database
+      
+      def map(map_function)
+        @map_function = map_function
+      end
+      
+      def reduce(reduce_function)
+        @reduce_function = reduce_function
+      end
+      
+      def for_database(database)
+        @database = database
+      end
+      
+      def to_json(existing_view = {})
+        results_hash = { '_id' => "_design/#{name}", 'language' => 'javascript' }
+        results_hash.merge!(existing_view)
+        results_hash['views'] = {
+          "#{name}" => { 'map' => @map_function }
+        }
+        results_hash['views']["#{name}"]['reduce'] = @reduce_function unless @reduce_function.nil?
+        # Convert to JSON
+        results_hash.to_json
+      end
+
+      def name
+        "#{self}".underscore
+      end
+      
+    end # End Class Methods
+  end # End Class RawView
+end # End module ActiveCouch

data/lib/active_couch/views/view.rb

@@ -0,0 +1,85 @@
+require 'json'
+
+module ActiveCouch
+  class View
+    class << self # Class Methods
+      # Class instance variables
+      @name = nil; @database = nil
+      # These are accessible only at class-scope
+      attr_accessor :name, :database
+      # Set the view name and database name in the define method and then execute
+      # the block
+      def define(*args)
+        # Borrowed from ActiveRecord::Base.find
+        first = args.slice!(0); second = args.slice!(0)
+        # Based on the classes of the arguments passed, set instance variables
+        case first.class.to_s
+          when 'String', 'Symbol' then name = first.to_s;  options = second || {}
+          when 'Hash' then  name = ''; options = first
+          else raise ArgumentError, "Wrong arguments used to define the view"
+        end
+        # Define the view and database instance variables based on the args passed
+        # Don't care if the key doesn't exist
+        @name, @database = get_name(name), options[:for_db]
+        # Block being called to set other parameters for the Migration
+        yield if block_given?
+      end
+      
+      def with_key(key = "")
+        @key = key unless key.nil?
+      end
+      
+      def with_filter(filter = "")
+        @filter = filter unless filter.nil?
+      end
+      
+      def include_attributes(*attrs)
+        @attrs = attrs unless attrs.nil? || !attrs.is_a?(Array)
+      end
+      
+      def to_json(existing_view = {})
+        results_hash = {  "_id" => "_design/#{@name}", "language" => view_language }
+        results_hash.merge!(existing_view)
+        results_hash['views'] = view_function
+        # Returns the JSON format for the function
+        results_hash.to_json
+      end
+
+private
+      def view_language
+        'javascript'
+      end
+
+      def include_attrs
+        attrs = "doc"
+        unless @attrs.nil?
+          js = @attrs.inject([]) {|result, att| result << "#{att}: doc.#{att}"}
+          attrs = "{#{js.join(' , ')}}" if js.size > 0
+        end
+        attrs
+      end
+      
+      def get_name(name)
+        view_name = name
+        view_name = "#{self}".underscore if name.nil? || name.length == 0
+        view_name  
+      end
+
+      def view_function
+        filter_present = !@filter.nil? && @filter.length > 0
+
+        js = "function(doc) { "
+        js << "if(#{@filter}) { " if filter_present
+        js << "emit(#{couchdb_view_mapper}, #{include_attrs});"
+        js << " } " if filter_present
+        js << " }"
+
+        { @name => {'map' => js} }
+      end
+
+      def couchdb_view_mapper
+        @key.nil? ? 'null' : "doc.#{@key}"
+      end
+    end # End Class Methods
+  end # End Class Migration
+end # End module ActiveCouch