make_commentable 0.0.6 → 0.0.7.a

data/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/make_commentable/{lib/generators → generators}/comment/templates/comment.rb

@@ -1,5 +1,5 @@
 class Comment < ActiveRecord::Base
-  include Commentable::Comment
+  #include Commentable::Comment
   attr_accessible :content, :parent_id
 
   acts_as_nested_set

data/make_commentable/lib/{commentable_methods.rb → make_commentable/commentable_methods.rb}

@@ -1,10 +1,16 @@
 require 'active_record'
+require 'active_support/concern'
 
-module MakeCommentable
+module Make
   module Commentable
+    extend ActiveSupport::Concern
 
-    def self.included(base)
-      base.extend ClassMethods
+    included do
+      # here you can define some scopes or what else
+    end
+
+    # This module contains instance methods
+    module InstanceMethods
     end
 
     module ClassMethods
@@ -12,19 +18,13 @@ module MakeCommentable
         has_many :comments, {:as => :commentable, :dependent => :destroy}.merge(options)
         accepts_nested_attributes_for :comments, :allow_destroy => true
 
-        include Commentable::InstanceMethods
-        extend Commentable::SingletonMethods
+        #include Commentable::InstanceMethods
+        #extend Commentable::SingletonMethods
       end
     end
 
     #This module contains class methods
     module SingletonMethods
     end
-
-    # This module contains instance methods
-    module InstanceMethods
-    end
   end
-end
-
-ActiveRecord::Base.send(:include, Commentable)
+end

data/make_commentable/lib/{version.rb → make_commentable/version.rb}

@@ -1,3 +1,3 @@
 module Commentable
-  VERSION = "0.0.6"
+  VERSION = "0.0.7.a"
 end

data/make_commentable/lib/make_commentable.rb

@@ -1,4 +1,4 @@
-require 'version'
+require 'make_commentable/commentable_methods'
+
+ActiveRecord::Base.send(:include, Make::Commentable)
 
-require 'commentable_methods'
-require 'comment_methods'

metadata

@@ -1,24 +1,40 @@
 --- !ruby/object:Gem::Specification
 name: make_commentable
 version: !ruby/object:Gem::Version
-  version: 0.0.6
-  prerelease: 
+  version: 0.0.7.a
+  prerelease: 6
 platform: ruby
 authors:
-- Unitmedia
+- Alexey Lukyanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-24 00:00:00.000000000 Z
+date: 2012-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: awesome_nested_set
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.1.3
+        version: 3.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,48 +42,45 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.1.3
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: awesome_nested_set
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.2.1
-  type: :development
+        version: 2.1.3
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.2.1
-description: gem for comments with awesome_nested_set
-email:
-- admin@unitmedia.ru
+        version: 2.1.3
+description: add comments implementation for Active Record
+email: zozz2008@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.rdoc
 files:
-- make_commentable/Rakefile
-- make_commentable/lib/comment_methods.rb
 - make_commentable/lib/make_commentable.rb
-- make_commentable/lib/version.rb
-- make_commentable/lib/commentable_methods.rb
-- make_commentable/lib/generators/comment/USEGA
-- make_commentable/lib/generators/comment/templates/create_comments.rb
-- make_commentable/lib/generators/comment/templates/comment.rb
-- make_commentable/lib/generators/comment/comment_generator.rb
-- make_commentable/README.md
-- make_commentable/LICENSE
-- make_commentable/init.rb
-- make_commentable/make_commentable.gemspec
-- make_commentable/Gemfile
-homepage: ''
+- make_commentable/lib/make_commentable/version.rb
+- make_commentable/lib/make_commentable/commentable_methods.rb
+- make_commentable/generators/comment/templates/create_comments.rb
+- make_commentable/generators/comment/templates/comment.rb
+- make_commentable/generators/comment/comment_generator.rb
+- README.rdoc
+homepage: https://rubygems.org/gems/make_commentable
 licenses: []
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- --main
+- README.rdoc
+- --inline-source
+- --line-numbers
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -79,13 +92,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: a gem for usage comments with awesome_nested_set
+summary: add comments implementation for Active Record
 test_files: []

data/make_commentable/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in commentable.gemspec
-gemspec

data/make_commentable/LICENSE

@@ -1 +0,0 @@
-Copyright (c) 2012 Unitmedia

data/make_commentable/README.md

@@ -1,29 +0,0 @@
-# Commentable
-
-TODO: Write a gem description
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'commentable'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install commentable
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request

data/make_commentable/Rakefile

@@ -1,2 +0,0 @@
-#!/usr/bin/env rake
-require "bundler/gem_tasks"

data/make_commentable/init.rb

@@ -1 +0,0 @@
-require File.join(File.dirname(__FILE__), 'rails', 'init')

data/make_commentable/lib/comment_methods.rb

@@ -1,23 +0,0 @@
-module Commentable
-  # including this module into your Comment model will give you finders and named scopes
-  # useful for working with Comments.
-  # The named scopes are:
-  #   in_order: Returns comments in the order they were created (created_at ASC).
-  #   recent: Returns comments by how recently they were created (created_at DESC).
-  #   limit(N): Return no more than N comments.
-  module Comment
-
-    def self.included(comment_model)
-      comment_model.extend Finders
-    end
-
-    module Finders
-      # Helper class method to look up a commentable object
-      # given the commentable class name and id
-      def find_commentable(commentable_str, commentable_id)
-        model = commentable_str.constantize
-        model.respond_to?(:find_comments_for) ? model.find(commentable_id) : nil
-			end
-    end
-  end
-end

data/make_commentable/lib/generators/comment/USEGA

@@ -1,6 +0,0 @@
-Description:
-    Copies comment.rb to app/models/.
-    Copies create_comment.rb to db/migrate
-
-Examples:
-    `rails generate comment`

data/make_commentable/make_commentable.gemspec

@@ -1,21 +0,0 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/version', __FILE__)
-
-Gem::Specification.new do |gem|
-  gem.authors       = ["Unitmedia"]
-  gem.email         = ["admin@unitmedia.ru"]
-  gem.description   = %q{gem for comments with awesome_nested_set}
-  gem.summary       = %q{a gem for usage comments with awesome_nested_set}
-  gem.homepage      = ""
-
-  gem.files         = Dir['make_commentable/**/*'].to_a
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "make_commentable"
-  gem.require_paths = ["lib"]
-  gem.version       = Commentable::VERSION
-
-  gem.add_runtime_dependency('awesome_nested_set', '>= 2.1.3')
-  gem.add_development_dependency('rails', '>= 3.2.1')
-  gem.rubygems_version = '>= 1.8.22'
-end