paloma 0.0.5 → 0.0.6

data/.gitignore

@@ -1,19 +1,7 @@
-*.rbc
-*.sassc
-.sass-cache
-capybara-*.html
-.rspec
-/.bundle
-/vendor/bundle
-/log/*
-/tmp/*
-/db/*.sqlite3
-/public/system/*
-/coverage/
-/spec/tmp/*
+Gemfile.lock
 *.gem
-/spec/sample_app/log
+/tmp/*
+/spec/tmp/
+/spec/sample_app/tmp/
+/spec/sample_app/log/
 /spec/sample_app/paloma_test
-**.orig
-rerun.txt
-pickle-email-*.html

data/Changelog.md

@@ -0,0 +1,10 @@
+Changelog
+=
+
+Version 0.0.5
+-
+* Callbacks are executed after the DOM is ready
+
+Version 0.0.4
+-
+* First release

data/Gemfile

@@ -1,3 +1,2 @@
 source "http://rubygems.org"
-
 gemspec

data/lib/paloma.rb

@@ -1,6 +1,23 @@
 module Paloma
+  mattr_accessor :destination, :templates
+  
   def self.root
-    @paloma_root ||= File.dirname(__FILE__) + '/../'
+    @paloma_root ||= "#{File.dirname(__FILE__)}/../"
+  end
+  
+  
+  def self.index_js
+    @index_js ||= "#{Paloma.destination}/index.js"
+  end
+  
+  
+  def self.destination
+    @destination ||= 'app/assets/javascripts/paloma'
+  end
+  
+  
+  def self.templates
+    @templates ||= "#{Paloma.root}/app/templates"
   end
 end
 
@@ -9,6 +26,7 @@ require 'rails/generators'
 
 # TODO: Rails version checking
 
-require 'paloma/paloma_generator'
+require 'paloma/generators/add_generator'
+require 'paloma/generators/setup_generator'
 require 'paloma/action_controller_filters'
 require 'paloma/action_controller_extension'

data/lib/paloma/generators/add_generator.rb

@@ -0,0 +1,69 @@
+module Paloma
+  #
+  # Usage: 
+  #   rails g paloma:add <controller_name>
+  #     - Generates the following:
+  #         - a folder under app/assets/javascripts/paloma named as <controller_name>
+  #         - callbacks.js inside the folder just made
+  #     - Updates index.js under the 'paloma' folder
+  #         - adds a line in order to require the callbacks to be made under the recently made folder
+  #
+  #
+  #   rails g paloma:add <controller_name>/<action_name>
+  #     - Generates the following:
+  #         - <action_name>.js file inside the <controller_name> folder
+  #
+  #
+  # Generated Files:
+  #  <controller_name>/callbacks.js
+  #    - contains code for requiring all callbacks under the same folder <controller_name> 
+  #
+  #  <controller_name>/<action_name>.js
+  #    - actual code to be executed when callback is called
+  #
+    
+  class AddGenerator < ::Rails::Generators::NamedBase
+    source_root Paloma.templates
+    
+    def create_callback_file
+      arg = file_path.split('/')
+      @controller_name = arg[0]
+      action_name = arg[1]
+      
+      controller_folder = "#{Paloma.destination}/#{@controller_name}/" 
+      callbacks_js = "#{controller_folder}/_callbacks.js"
+      local_js = "#{controller_folder}/_local.js"
+      action_js = "#{controller_folder}/#{action_name}.js"
+        
+      Dir.mkdir(controller_folder) unless Dir.exists?(controller_folder)
+      
+      generate_from_template local_js unless File.exists?(local_js)
+      generate_from_template callbacks_js unless File.exists?(callbacks_js)        
+      
+      # Create a js file for action if there is an action argument
+      if action_name.present? && !File.exists?(action_js)
+        content = File.read("#{Paloma.templates}/action.js").gsub(
+          /controller\/action/, 
+          "#{@controller_name}/#{action_name}")
+          
+        File.open(action_js, 'w'){ |f| f.write(content) }
+      end
+      
+      # Require controller's _callbacks.js to Paloma's main index.js file.
+      # Located on "#{Paloma.destination}/index.js" or by default on
+      # app/assets/javascripts/paloma/index.js
+      File.open(Paloma.index_js, 'a+'){ |f| 
+        f << "\n//= require ./#{@controller_name}/_callbacks"
+      }
+    end
+    
+    
+    private
+    
+    def generate_from_template destination_filename
+      filename = destination_filename.split('/').last
+      content = File.read("#{Paloma.templates}/_local.js").gsub(/controller/, @controller_name)
+      File.open(destination_filename, 'w'){ |f| f.write(content) }
+    end 
+  end
+end

data/lib/paloma/generators/setup_generator.rb

@@ -0,0 +1,28 @@
+module Paloma
+  #
+  # rails g paloma:setup
+  #   - Generates the following:
+  #     - 'paloma' folder under app/assets/javascripts/
+  #     - index.js and paloma.js under the 'paloma' folder
+  #
+  # Generated Files:
+  # index.js
+  #   - contains code for requiring all callbacks of all folders
+  #   - always updated when new folders and callback.js files are created
+  #
+  # paloma.js
+  #   - declaration of namespace used in all callbacks
+  #
+
+  class SetupGenerator < ::Rails::Generators::Base
+    source_root Paloma.templates
+    
+    def setup_paloma
+      index_js = "#{Paloma.destination}/index.js"
+      paloma_js = "#{Paloma.destination}/paloma.js"
+      
+      copy_file 'index.js', index_js unless File.exists?(index_js)
+      copy_file 'paloma.js', paloma_js unless File.exists?(paloma_js)
+    end
+  end
+end

data/paloma.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'paloma'
-  s.version     = '0.0.5'
+  s.version     = '0.0.6'
   s.summary     = "a sexy way to organize javascript files using Rails` asset pipeline"
   s.description = "a sexy way to organize javascript files using Rails` asset pipeline"
   s.authors     = ["Karl Paragua", "Bia Esmero"]
@@ -11,12 +11,11 @@ Gem::Specification.new do |s|
   s.add_dependency 'jquery-rails'
   
   s.add_development_dependency 'rails', ['>= 3.1.0']
-  s.add_development_dependency 'bundler', ['>= 1.0.0']
   s.add_development_dependency 'rake', ['>= 0']
   s.add_development_dependency 'sqlite3', ['>= 0']
   s.add_development_dependency 'rspec', ['>= 0']
   s.add_development_dependency 'rspec-rails', ['~> 2.0']
+  s.add_development_dependency 'generator_spec', ['~> 0.8.7']
   s.add_development_dependency 'capybara', ['>= 1.0']
   s.add_development_dependency 'database_cleaner', ['>= 0']
-  s.add_development_dependency 'launchy', ['>= 0']
 end

data/spec/callback_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
-
+=begin
 feature 'Callbacks' do
   
   it 'should execute articles/new callback', :js => true do
@@ -15,8 +15,6 @@ feature 'Callbacks' do
     fill_in 'article[body]', :with => 'sexy paloma body'
     click_button 'Save'
     
-    print page.html
-    
     page.has_selector?('#from-articles-create-callback').should == true
     page.has_selector?('#from-articles-show-callback').should == true
   end
@@ -65,3 +63,4 @@ feature 'Callbacks' do
     page.has_selector?('#from-articles-edit-callback').should == true
   end
 end
+=end

data/spec/generator_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+require 'generator_spec/test_case'
+require 'fileutils'
+
+TEMP = "#{File.dirname(__FILE__)}/tmp/"
+
+feature Paloma::SetupGenerator do
+  include GeneratorSpec::TestCase
+  destination TEMP
+  
+  before do
+    prepare_destination
+    run_generator
+  end
+  
+  specify do
+    destination_root.should have_structure {
+      directory Paloma.destination do
+        file 'paloma.js'
+        file 'index.js'
+      end
+    }
+  end
+end
+
+
+
+def mimic_setup
+  # Mimic SetupGenerator results before running the AddGenerator
+  FileUtils.cd TEMP
+  FileUtils.mkpath Paloma.destination
+  File.open("#{Paloma.destination}/index.js", 'w') { |f| f.write('// test')}
+end
+
+
+
+feature Paloma::AddGenerator, 'creating controller folder only' do
+  include GeneratorSpec::TestCase
+  destination TEMP
+  arguments ['sexy_controller']
+  
+  before do
+    prepare_destination
+    mimic_setup
+    run_generator
+  end
+  
+  specify do
+    destination_root.should have_structure {
+      directory Paloma.destination do
+        directory 'sexy_controller'
+        
+        file 'index.js' do
+          contains '//= require ./sexy_controller/_callbacks'
+        end
+      end
+    }
+  end
+end
+
+
+
+feature Paloma::AddGenerator, 'creating action with existing controller folder' do
+  include GeneratorSpec::TestCase
+  destination TEMP
+  arguments ['existing_controller_folder/new_action']
+  
+  before do
+    prepare_destination
+    mimic_setup
+    Dir.mkdir "#{Paloma.destination}/existing_controller_folder"
+    
+    run_generator
+  end
+  
+  specify do
+    destination_root.should have_structure {
+      directory Paloma.destination do
+        directory 'existing_controller_folder' do
+          file 'new_action.js' do
+            contains "Paloma.callbacks['existing_controller_folder/new_action']"
+          end
+        end
+      end
+    }
+  end
+end
+
+
+
+feature Paloma::AddGenerator, 'creating both controller folder and action file' do
+  include GeneratorSpec::TestCase
+  destination TEMP
+  arguments ['new_controller_folder/new_action']
+  
+  before do
+    prepare_destination
+    mimic_setup
+    run_generator
+  end
+  
+  specify do
+    destination_root.should have_structure {
+      directory Paloma.destination do
+        directory 'new_controller_folder' do
+          file 'new_action.js' do
+            contains "Paloma.callbacks['new_controller_folder/new_action']"
+          end
+        end
+      end
+    }
+  end
+end

data/spec/sample_app/controllers.rb

@@ -52,3 +52,11 @@ class ArticlesController < ApplicationController
   end
   
 end
+
+module SampleNamespace
+  class CategoriesController < ApplicationController
+    def index
+      raise controller_path.inspect
+    end
+  end
+end

data/spec/sample_app/init.rb

@@ -27,7 +27,8 @@ app.initialize!
 # Routes
 app.routes.draw do
   resources :articles, :controller => 'Articles'
+  resources :categories, :module => 'SampleNamespace'
 end
 
-require "#{Paloma.root}/spec/sample_app/model"
+require "#{Paloma.root}/spec/sample_app/models"
 require "#{Paloma.root}/spec/sample_app/controllers"

data/spec/sample_app/{model.rb → models.rb}

@@ -5,24 +5,36 @@ ActiveRecord::Base.configurations = {'test' => {:adapter => 'sqlite3', :database
 ActiveRecord::Base.establish_connection('test')
 
 
-# Model
+# Models
 class Article < ActiveRecord::Base
-  attr_accessible :title, :body
-  
+  attr_accessible :title, :body, :category, :category_id
+  belongs_to :category
   validates_presence_of :title
 end
 
 
+class Category < ActiveRecord::Base
+  attr_accessible :name
+  has_many :articles, :dependent => :destroy
+  validates_presence_of :name
+end
+
+
 # Migration
-class CreateArticles < ActiveRecord::Migration
+class CreateTables < ActiveRecord::Migration
   def self.up
     create_table :articles, :force => true do |t| 
       t.string :title
       t.string :body
+      t.references :category
+    end
+    
+    create_table :categories, :force => true do |t|
+      t.string :name
     end
   end
 end
 
 
 ActiveRecord::Migration.verbose = false
-CreateArticles.up
+CreateTables.up

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paloma
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-20 00:00:00.000000000 Z
+date: 2012-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jquery-rails
@@ -44,22 +44,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.1.0
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -125,29 +109,29 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: capybara
+  name: generator_spec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.8.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.8.7
 - !ruby/object:Gem::Dependency
-  name: database_cleaner
+  name: capybara
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -155,9 +139,9 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: launchy
+  name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -179,23 +163,25 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- Changelog.md
 - Gemfile
-- Gemfile.lock
 - License
 - README.md
 - Rakefile
+- app/templates/_callbacks.js
+- app/templates/_local.js
+- app/templates/action.js
+- app/templates/index.js
+- app/templates/paloma.js
 - app/views/paloma/_callback_hook.html.erb
 - lib/paloma.rb
 - lib/paloma/action_controller_extension.rb
 - lib/paloma/action_controller_filters.rb
-- lib/paloma/paloma_generator.rb
-- lib/paloma/templates/_callbacks.js
-- lib/paloma/templates/_local.js
-- lib/paloma/templates/action.js
-- lib/paloma/templates/index.js
-- lib/paloma/templates/paloma.js
+- lib/paloma/generators/add_generator.rb
+- lib/paloma/generators/setup_generator.rb
 - paloma.gemspec
 - spec/callback_spec.rb
+- spec/generator_spec.rb
 - spec/sample_app/app/assets/javascripts/application.js
 - spec/sample_app/app/assets/javascripts/paloma/articles/callbacks.js
 - spec/sample_app/app/assets/javascripts/paloma/articles/create.js
@@ -212,7 +198,7 @@ files:
 - spec/sample_app/app/views/layouts/application.html.erb
 - spec/sample_app/controllers.rb
 - spec/sample_app/init.rb
-- spec/sample_app/model.rb
+- spec/sample_app/models.rb
 - spec/spec_helper.rb
 homepage: https://github.com/kbparagua/paloma
 licenses: []
@@ -234,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.21
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: a sexy way to organize javascript files using Rails` asset pipeline

data/Gemfile.lock

@@ -1,148 +0,0 @@
-PATH
-  remote: .
-  specs:
-    paloma (0.0.4)
-      jquery-rails
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    actionmailer (3.2.9)
-      actionpack (= 3.2.9)
-      mail (~> 2.4.4)
-    actionpack (3.2.9)
-      activemodel (= 3.2.9)
-      activesupport (= 3.2.9)
-      builder (~> 3.0.0)
-      erubis (~> 2.7.0)
-      journey (~> 1.0.4)
-      rack (~> 1.4.0)
-      rack-cache (~> 1.2)
-      rack-test (~> 0.6.1)
-      sprockets (~> 2.2.1)
-    activemodel (3.2.9)
-      activesupport (= 3.2.9)
-      builder (~> 3.0.0)
-    activerecord (3.2.9)
-      activemodel (= 3.2.9)
-      activesupport (= 3.2.9)
-      arel (~> 3.0.2)
-      tzinfo (~> 0.3.29)
-    activeresource (3.2.9)
-      activemodel (= 3.2.9)
-      activesupport (= 3.2.9)
-    activesupport (3.2.9)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    addressable (2.3.2)
-    arel (3.0.2)
-    builder (3.0.4)
-    capybara (2.0.1)
-      mime-types (>= 1.16)
-      nokogiri (>= 1.3.3)
-      rack (>= 1.0.0)
-      rack-test (>= 0.5.4)
-      selenium-webdriver (~> 2.0)
-      xpath (~> 1.0.0)
-    childprocess (0.3.6)
-      ffi (~> 1.0, >= 1.0.6)
-    database_cleaner (0.9.1)
-    diff-lcs (1.1.3)
-    erubis (2.7.0)
-    ffi (1.2.0)
-    hike (1.2.1)
-    i18n (0.6.1)
-    journey (1.0.4)
-    jquery-rails (2.1.4)
-      railties (>= 3.0, < 5.0)
-      thor (>= 0.14, < 2.0)
-    json (1.7.5)
-    launchy (2.1.2)
-      addressable (~> 2.3)
-    libwebsocket (0.1.7.1)
-      addressable
-      websocket
-    mail (2.4.4)
-      i18n (>= 0.4.0)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    mime-types (1.19)
-    multi_json (1.5.0)
-    nokogiri (1.5.5)
-    polyglot (0.3.3)
-    rack (1.4.1)
-    rack-cache (1.2)
-      rack (>= 0.4)
-    rack-ssl (1.3.2)
-      rack
-    rack-test (0.6.2)
-      rack (>= 1.0)
-    rails (3.2.9)
-      actionmailer (= 3.2.9)
-      actionpack (= 3.2.9)
-      activerecord (= 3.2.9)
-      activeresource (= 3.2.9)
-      activesupport (= 3.2.9)
-      bundler (~> 1.0)
-      railties (= 3.2.9)
-    railties (3.2.9)
-      actionpack (= 3.2.9)
-      activesupport (= 3.2.9)
-      rack-ssl (~> 1.3.2)
-      rake (>= 0.8.7)
-      rdoc (~> 3.4)
-      thor (>= 0.14.6, < 2.0)
-    rake (10.0.3)
-    rdoc (3.12)
-      json (~> 1.4)
-    rspec (2.12.0)
-      rspec-core (~> 2.12.0)
-      rspec-expectations (~> 2.12.0)
-      rspec-mocks (~> 2.12.0)
-    rspec-core (2.12.2)
-    rspec-expectations (2.12.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.12.0)
-    rspec-rails (2.12.0)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec-core (~> 2.12.0)
-      rspec-expectations (~> 2.12.0)
-      rspec-mocks (~> 2.12.0)
-    rubyzip (0.9.9)
-    selenium-webdriver (2.27.2)
-      childprocess (>= 0.2.5)
-      libwebsocket (~> 0.1.3)
-      multi_json (~> 1.0)
-      rubyzip
-    sprockets (2.2.2)
-      hike (~> 1.2)
-      multi_json (~> 1.0)
-      rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    sqlite3 (1.3.6)
-    thor (0.16.0)
-    tilt (1.3.3)
-    treetop (1.4.12)
-      polyglot
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.35)
-    websocket (1.0.4)
-    xpath (1.0.0)
-      nokogiri (~> 1.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (>= 1.0.0)
-  capybara (>= 1.0)
-  database_cleaner
-  launchy
-  paloma!
-  rails (>= 3.1.0)
-  rake
-  rspec
-  rspec-rails (~> 2.0)
-  sqlite3

data/lib/paloma/paloma_generator.rb

@@ -1,95 +0,0 @@
-module Paloma
-  #
-  # Setup:
-  #   rails g paloma:setup
-  #     - Generates the following:
-  #         - 'paloma' folder under app/assets/javascripts/paloma
-  #         - index.js and paloma.js under the 'paloma' folder
-  #
-  #
-  # Usage: 
-  #   rails g paloma:add <controller_name>
-  #     - Generates the following:
-  #         - a folder under app/assets/javascripts/paloma named as <controller_name>
-  #         - callbacks.js inside the folder just made
-  #     - Updates index.js under the 'paloma' folder
-  #         - adds a line in order to require the callbacks to be made under the recently made folder
-  #
-  #
-  #   rails g paloma:add <controller_name>/<action_name>
-  #     - Generates the following:
-  #         - <action_name>.js file inside the <controller_name> folder
-  #
-  #
-  # Generated Files:
-  #  index.js
-  #    - contains code for requiring all callbacks of all folders
-  #    - always updated when new folders and callback.js files are created
-  #
-  #  paloma.js
-  #    - declaration of namespace used in all callbacks
-  #
-  #  <controller_name>/callbacks.js
-  #    - contains code for requiring all callbacks under the same folder <controller_name> 
-  #
-  #  <controller_name>/<action_name>.js
-  #    - actual code to be executed when callback is called
-  #
-    
-  PARENT  = 'app/assets/javascripts/paloma/'
-  INDEX = PARENT + 'index.js'
-  PALOMA = PARENT + 'paloma.js'
-  
-  class SetupGenerator < ::Rails::Generators::Base
-    source_root File.expand_path('../templates', __FILE__)
-    
-    def setup_paloma
-      #index.js on callbacks folder
-      has_index = File.exists? INDEX
-      copy_file 'index.js', INDEX unless has_index  
-      
-      has_paloma = File.exists? PALOMA
-      copy_file 'paloma.js', PALOMA unless has_paloma
-    end
-    
-  end
-  
-  
-  class AddGenerator < ::Rails::Generators::NamedBase
-    source_root File.expand_path('../templates', __FILE__)
-    
-    def create_callback_file
-      file = file_path.split('/')
-      controller = file[0]
-      action = file[1]
-      
-      callbacks = PARENT + "#{controller}/_callbacks.js"
-      templates = "#{Paloma.root}/lib/paloma/templates/"
-      local = PARENT + "#{controller}/_local.js"
-      action_file = PARENT + "#{controller}/#{action}.js"
-      
-      #_callbacks.js per folder(controller)
-      has_callbacks = File.exists? callbacks
-      unless has_callbacks
-        Dir.mkdir(PARENT + "#{controller}")
-        content = File.read(templates + '_callbacks.js').gsub('controller', "#{controller}")
-        File.open(callbacks, 'w'){ |f| f.write(content) }
-        File.open(INDEX, 'a+'){ |f| f << "\n//= require ./" + controller + '/_callbacks' }
-      end
-      
-      #_local.js per folder(controller)
-      has_local =File.exists? local
-      unless has_local
-        content = File.read(templates + '_local.js').gsub('controller', "#{controller}")
-        File.open(local, 'w'){ |f| f.write(content) }
-      end
-      
-      #<action>.js on folder(controller) - code for callback
-      has_action = File.exists? action_file
-      unless (action.nil? || has_action)
-        content = File.read(templates + 'action.js').gsub('controller/action', "#{controller}/#{action}")
-        File.open(action_file, 'w'){ |f| f.write(content) }
-      end
-    end    
-  end
-end