krasivotokak-espresso 0.0.1 → 0.0.2

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/espresso.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{espresso}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alexander Semyonov"]
-  s.date = %q{2009-08-15}
+  s.date = %q{2009-08-17}
   s.description = %q{Useful templates for controller and model functions}
   s.email = %q{rotuka@rotuka.com}
   s.extra_rdoc_files = [

data/lib/espresso/controller.rb

@@ -1,13 +1,17 @@
 require 'inherited_resources'
 
 module Espresso
-  class Controller < InheritedResources::Base
+  class ObjectsController < InheritedResources::Base
+    # Same as default InheritedResources::Base#new, but render 'edit' view,
+    # other than 'new'
     def new
       new! do |format|
         format.html { render 'edit' }
       end
     end
 
+    # Same as default InheritedResources::Base#create, but render 'edit' view,
+    # other than 'new'
     def create
       create! do |success, failure|
         failure.html { render 'edit' }
@@ -15,6 +19,11 @@ module Espresso
     end
 
   protected
+
+    # Find collection of objects with pagination.
+    # Also made Searchlogic object @search
+    #
+    # @return [WillPaginate::Collection] collection of objects
     def collection
       unless (result = get_collection_ivar).present?
         @search, result = end_of_association_chain.paginate_found(params[:page], params[:query], params[:q])

data/lib/espresso/model.rb

@@ -1,6 +1,7 @@
 require 'searchlogic'
 
 module Espresso
+  # @author Alexander Semyonov
   module Model
     def self.included(model)
       model.extend ClassMethods
@@ -13,6 +14,14 @@ module Espresso
     end
 
     module ClassMethods
+      # Paginates search results
+      #
+      # @param [Integer] page number of results’ page
+      # @param [Hash] query searchlogic fields (proc’ed named scopes’ names with values)
+      # @param [String] simple_query params for simple «LIKE '%something%'» searches (e.g. /people?q=Alexander)
+      # @return [Array] searchlogic object and collection of results
+      #
+      # @todo Add an options to paginating
       def paginate_found(page = nil, query = nil, simple_query = nil)
         query ||= {}
         query.merge(parse_simple_query(simple_query)) if simple_query.present?
@@ -21,17 +30,28 @@ module Espresso
         [@search, @results]
       end
 
+      # Make searchlogic query from simple query option
+      # Needed to be reimplemented in subclasses
+      #
+      # @param [String] simple query string
+      # @return [Hash] searchlogic query
       def parse_simple_query(query)
         {:"#{name_field}_like" => query}
       end
 
+      # «NameField» is a main field, used to represent model in to_s method and in simple queries
+      # @param [Symbol, String] new_name_field new field name
+      # @return [Symbol] field name
       def name_field(new_name_field = nil)
         if new_name_field.present?
-          @@name_field = new_name_field
+          @@name_field = new_name_field.to_sym
         end
         @@name_field
       end
 
+      # Make a slug from object’s NameField
+      # @param [ActiveRecord::Base] object, which slug is making
+      # @return [String] slug
       def make_slug(object)
         object.send(name_field).parameterize
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: krasivotokak-espresso
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Alexander Semyonov
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-15 00:00:00 -07:00
+date: 2009-08-17 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency