codus 0.0.1

data/README.md

@@ -0,0 +1,138 @@
+Codus
+=====
+
+Tools to improve your life as Rails developer.
+
+
+
+Javascript Organizer
+--------------------
+
+You can write your javascript functions using [yojs namespaces declaration](https://github.com/codus/yojs). Namespaces that matches your application name, current controller and current action will automatic be fired.
+
+### Setup
+
+
+
+- Put in your Gemfile:
+
+```ruby
+gem 'codus'
+```
+
+- Install the gem with *bundle install*
+
+- Put in your layout: 
+
+`<%= load_yojs(:app_name => 'yourappname') %>`
+
+- Put in your application.js
+
+```javascript
+//= require jquery
+//= require yojs
+```
+
+- Declare your functions using yojs and enjoy your life
+
+
+
+**Options**
+
+
+
+***app_name***
+
+The *load_yojs* helper method will print a javascript code, using query and yojs, that calls namespaces matching the app_name option, current controller name and current action name.
+
+
+
+For instance, if you're in /posts/new it will call:
+
+
+
+1. yourappname
+
+2. yourappname.posts
+
+3. yourappname.posts.new
+
+
+
+***onload_method_name***
+
+You can set the name of the last namespace to be called on the unload event with the *onload_method_name* option. For instance:
+
+
+```erb
+<%= load_yojs(:app_name => 'yourappname', :onload_method_name => "myonloadmethod") %>
+```
+
+If you're in /posts/new it will call:
+
+1. yourappname.<myonloadmethod>
+
+2. yourappname.posts.<myonloadmethod>
+
+3. yourappname.posts.new.<myonloadmethod>
+
+
+***method_names_mapper***
+
+You can also configure equivalent namespaces using :<method_names_mapper. For instance:>
+
+
+
+```erb
+<%= load_yojs(:app_name => 'yourappname', 
+
+                     :method_names_mapper => {
+
+                                  :create => :new,
+
+                                  :update => :edit
+
+                                }
+
+                    )%>
+```
+
+If you're in /posts/create it will call:
+
+1. yourappname
+
+2. yourappname.posts
+
+3. yourappname.posts.create
+
+4. yourappname.posts.new
+
+
+File structure
+--------------------
+
+We recomend you to structure your js files according your namespace hierarchy. Example
+
+```
+- assets
+  |- javascripts 
+     |- application.js
+     |- components (jquery, plugins, etc)
+     |- myapp
+     |  |- myapp.js (global javascripts in "myapp" namespace)
+     |  |- controller1
+     |  |  |- controller1.js (javascripts shared between "myapp.controller1" namespace)
+     |  |  |- action1.js (javascripts for "myapp.controller1.action1" namespace)
+     |  |  |- action2.js (javascripts for "myapp.controller1.action2" namespace)
+     |  |  |- actionN.js (javascripts for "myapp.controller1.actionN" namespace)
+     |  |  
+     |  |- controller2
+     |  |  |- controller2.js (javascripts shared between "myapp.controller2" namespace)
+     |  |  |- action1.js (javascripts for "myapp.controller2.action1" namespace)
+     |  |  |- action2.js (javascripts for "myapp.controller2.action2" namespace)
+     |  |  |- actionN.js (javascripts for "myapp.controller2.actionN" namespace)
+     |  |  
+     |  |- controllerN
+     |  |  |- controllerN.js (javascripts shared between "myapp.controllerN" namespace)
+     |  |  |- ...
+``` 

data/lib/README.md

@@ -0,0 +1,122 @@
+Codus
+=====
+
+Tools to improve your life as Rails developer.
+
+
+
+Javascript Organizer
+--------------------
+
+You can organize your javascript functions using yojs namespaces declaration and
+the ones that matches your application name, current controller and current
+action will automatic be fired.
+
+
+
+### Setup
+
+
+
+1. Put in your Gemfile:
+
+gem 'codus'
+
+2. Install the gem with *bundle install*
+
+3. Put in your layout:
+
+`<%= load_yojs(:app_name => 'yourappname') %>`
+
+4. Put in your application.js
+
+`//= require jquery`
+
+`//= require yojs`
+
+5. Declare your functions using yojs and enjoy your life
+
+
+
+**Options**
+
+
+
+**app_name**
+
+The *load_yojs* helper method will print a javascript code, using query and
+yojs, that calls namespaces matching the app_name option, current controller name
+and current action name.
+
+
+
+For instance, if you're in /posts/new it will call:
+
+
+
+1. yourappname
+
+2. yourappname.posts
+
+3. yourappname.posts.new
+
+
+
+**onload_method_name**
+
+You can set the name of the last namespace to be called on the unload event with
+the
+
+<onload_method_name option. >For instance:
+
+
+
+`<%= load_yojs(:app_name => 'yourappname', :onload_method_name =>
+"myonloadmethod") %>`
+
+
+
+If you're in /posts/new it will call:
+
+
+
+1. yourappname.<myonloadmethod>
+
+2. yourappname.posts.<myonloadmethod>
+
+3. yourappname.posts.new.<myonloadmethod>
+
+
+
+**method_names_mapper**
+
+You can also configure equivalent namespaces using :<method_names_mapper. For
+instance:>
+
+
+
+`<%= load_yojs(:app_name => 'yourappname', `
+
+                    ` :method_names_mapper => {`
+
+                    `              :create => :new,`
+
+                    `              :update => :edit`
+
+                    `            }`
+
+                    `)%>`
+
+
+
+If you're in /posts/create it will call:
+
+
+
+1. yourappname
+
+2. yourappname.posts
+
+3. yourappname.posts.create
+
+4. yourappname.posts.new

data/lib/codus.rb

@@ -0,0 +1,11 @@
+require 'rails/engine'
+require "codus/version"
+require "codus/view_helpers"
+
+module Codus
+  class Engine < ::Rails::Engine
+    initializer "Codus.view_helpers" do |app|
+      ActionView::Base.send :include, Codus::ViewHelpers
+    end
+  end
+end

data/lib/codus/version.rb

@@ -0,0 +1,3 @@
+module Codus
+  VERSION = "0.0.1"
+end

data/lib/codus/view_helpers.rb

@@ -0,0 +1,12 @@
+require "codus/view_helpers/yojs_helper"
+
+module Codus
+  module ViewHelpers
+    include Codus::ViewHelpers::YojsHelper
+    
+    def javascript_ready(&block)
+      javascript_tag("$(function(){\n" + capture(&block) + "});").html_safe
+    end
+
+  end
+end

data/lib/codus/view_helpers/yojs_helper.rb

@@ -0,0 +1,12 @@
+require "codus/view_helpers/yojs_helper/yojs_call_generator"
+
+module Codus
+  module ViewHelpers
+    module YojsHelper
+      def load_yojs(options = {})
+        call_generator = YojsCallGenerator.new(params[:controller], params[:action], options)
+        javascript_ready { call_generator.generate_yojs_calls() }.html_safe
+      end
+    end
+  end
+end

data/lib/codus/view_helpers/yojs_helper/yojs_call_generator.rb

@@ -0,0 +1,70 @@
+module Codus
+  module ViewHelpers
+    module YojsHelper
+      class YojsCallGenerator
+        def initialize(controller, action, options = {})
+          @options = merge_options_with_defaults(options)
+          @parent_namespace = "#{@options[:app_name]}.#{controller.parameterize('.')}"
+          @last_namespace = action.parameterize(".")
+          @fullnamespace = "#{@parent_namespace}.#{@last_namespace}"
+          
+        end
+
+        def merge_options_with_defaults(options)
+          default_options = { :app_name => "", 
+            :onload_method_name => "",
+            :method_names_mapper => {
+              :create => :new,
+              :update => :edit
+            }
+          }
+          mapping_options = options.delete(:method_names_mapper)
+          default_options[:method_names_mapper].merge!(mapping_options) unless mapping_options.nil? 
+          default_options.merge(options)
+        end
+
+        def generate_yojs_calls
+          namespaces_to_call_onload = get_all_namespaces_from_full_namespace
+          onload_calls_definitions = append_onload_method_to_namespaces(namespaces_to_call_onload)
+          conditional_callings = generate_conditional_function_calling_for_namespaces(onload_calls_definitions)
+          conditional_callings.join("\n").html_safe
+        end
+
+        def get_all_namespaces_from_full_namespace
+          namespaces = []
+          @fullnamespace.split(".").each do |actual_namespace| 
+            if namespaces.empty?
+              namespaces << actual_namespace
+            else
+              namespaces << ("#{namespaces.last}.#{actual_namespace}")
+            end
+          end
+          if @options[:method_names_mapper].has_key?(@fullnamespace.split(".").last.to_sym)
+            namespaces << ("#{@parent_namespace}.#{@options[:method_names_mapper][@last_namespace.to_sym]}")
+          end
+          namespaces
+        end
+
+        def append_onload_method_to_namespaces(namespaces = [])
+          return namespaces if @options[:onload_method_name].nil? || @options[:onload_method_name] == ""
+          namespaces.map do |namespace_to_call_onload|
+            "#{namespace_to_call_onload}.#{@options[:onload_method_name]}"
+          end
+        end
+
+        def generate_conditional_function_calling_for_namespaces(namespaces = [])
+          namespaces.map do |call_definition| 
+            "
+              if (yojs.isDefined(\"#{call_definition}\")) {
+                yojs.call(\"#{call_definition}\");
+              }
+            "
+          end
+        end
+
+        
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: codus
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Vinícius Oyama
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Organize your javascript across namespaces matching your controllers
+  and actions. Get automatic executing functions for current controller and action.
+email: vinicius.oyama@codus.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/codus/version.rb
+- lib/codus/view_helpers/yojs_helper/yojs_call_generator.rb
+- lib/codus/view_helpers/yojs_helper.rb
+- lib/codus/view_helpers.rb
+- lib/codus.rb
+- lib/README.md
+- README.md
+homepage: https://github.com/codus/codus
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Organize your javascript across namespaces matching your controllers and
+  actions. Get automatic executing functions for current controller and action.
+test_files: []