rails-script 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3bffb2e78ae2ba45d22290425852f260a7b1bbe2
+  data.tar.gz: 0b56e7b4a597ed5e5d6a83ea35d80640d012f7fa
+SHA512:
+  metadata.gz: cc463ae5d2918dbb5a04f187caf15ddcb771e88529c51afa1c03dae66318916dc1e3104fada1ff28be7975d5c38cac9a08865adf83c06c553ef9e1df366288aa
+  data.tar.gz: 3a57ae9c45d46430f80bcab7dbae48846b6adce3fde56824afe3df12d69d4d00a1aa5fd628460a78b3eca6e5b6d6df8b21cd2b56e2db2c4d2029827295c08df5

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kevin
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,171 @@
+# Rails Script
+
+Rails Script is a Rails-centric, object oriented, featherweight framework for writting CoffeeScript.  It is optomized for the [Rails Asset Pipeline](http://guides.rubyonrails.org/asset_pipeline.html) and is compatible with [TurboLinks](https://github.com/rails/turbolinks).  Using Rails controller names and actions to call JavaScript, it has never been easier to write clean, concise, and maintanable page specific JavaScript.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rails-script'
+
+And then execute:
+
+    $ bundle
+    
+After bundling you need to run the initial installation generator:
+
+    $ rails g rails_script:install
+    
+After the generator finishes, you will be prompted to add some JavaScript to your application layout.  The code is responsible for initializing and call the action specific JavaScript.  This snippet should be added before the closing body tag.
+
+For ERB:
+```
+<script>
+    jQuery(function() {
+        window.$this = new (App.#{controller_path.split(/\/|_/).map(&:capitalize).join('')} || App.Base)();
+        if (typeof $this.#{action_name} === 'function') {
+          return $this.#{action_name}.call();
+        }
+    });
+</script>
+```
+
+For HAML:
+```
+:javascript
+  jQuery(function() {
+    window.$this = new (App.\#{controller_path.split(/\/|_/).map(&:capitalize).join('')} || App.Base)();
+    if (typeof $this.\#{action_name} === 'function') {
+      return $this.\#{action_name}.call();
+    }
+  });
+```
+
+## Usage
+
+### Global Functions
+
+Any functions that need to be accessible in the global scope should be defined in ```global.js.coffee``` using the ```App``` namespace.  Below is an example of one of our favorite functions that we use to submit a jorm using AJAX as a JSON request.
+
+```
+# app/assets/javascripts/global.js.coffee
+window.App ||= {}
+
+App.remoteSubmission = ($form, onCompleteCallBack) ->
+  $.ajax
+    url: $form.attr('action')
+    type: $form.attr('method')
+    data: $form.serialize()
+    dataType: 'json'
+    complete: (result) ->
+      onCompleteCallBack(result)
+
+  return
+```
+
+Now you can access this function from anywhere in the application by just calling ```App.remoteSubmission($('#myForm', alert('Hello'))```
+
+
+### Page Specific JavaScript
+
+This is where things get even easier, your JavaScript class is named after your Controller and there is a method for each Controller action.  Whenever you generate a Controller, the CoffeeScript file that is generated will define the new JavaScript class and the basic REST actions.  This means on ```Users#show``` we can submit that 'follow' request in the background like so:
+
+```
+# app/assets/javascripts/users.js.coffee
+
+window.App ||= {}
+class App.Users extends App.Base
+
+   show: ->
+      App.remoteSubmission($('#follow-user-form'), alert('You are now following them!'))
+```
+
+
+### Controller Specific JavaScript
+
+Executing some JavaScript to run on all controller actions is just a matter of adding it to the class contstructor.  In the below example we will change the background color of the page for all actions in ```UsersController```.
+
+```
+# app/assets/javascripts/users.js.coffee
+window.App ||= {}
+class App.Example extends App.Base
+
+  constructor: ->
+    super
+    $('body').css('background-color', 'yellow')
+    return this
+```
+
+Note the call to ```super``` and the ```return this```, it is very important to keep these.  If you wanted your Controller specific JavaScript to run before Application wide JavaScript, then you would call ```super``` just before ```return this```.  Returning ```this``` allows the Application layout JavaScript to call the action specific functions.
+
+
+### Application Wide JavaScript
+
+Running some JavaScript on every page of an Application is a common need.  For example, we may want to create a site credit rollover in the footer of every page.
+
+```
+# app/assets/javascripts/base.js.coffee
+window.App ||= {}
+class App.Base
+
+  constructor: ->
+    @footerRollover()
+    return this
+    
+  footerRollover: ->
+    $(".site-credit a").hoverIntent(
+      over: ->
+        $(".site-credit a").html("<div class='maui-logo'></div>")
+      out: ->
+        $(".site-credit a").html("SITE CREDIT")
+    )
+```
+
+In this example we extracted the rollover action into a new function.  Doing so will make the class cleaner and easier to maintain as the application grows.  Once again note the ```return this``` in the contructor.
+
+
+### Generating New Controllers
+
+When a new controller is generated, the JavaScript asset file will be generated with Rails Script.  However, if you need to manually generate a Rails Script controller you can use:
+
+    $ rails g rails_script:controller Some::NewController
+    
+Since the above example includes a namespace, it would generate:
+
+```
+# app/assets/javascripts/some/new_controller.js.coffee
+
+window.App ||= {}
+class App.SomeNewController extends App.Base
+
+  constructor: ->
+    super
+    return this
+
+
+  index: ->
+    return
+
+
+  show: ->
+    return
+
+
+  new: ->
+    return
+
+
+  edit: ->
+    return
+```
+
+None of the pre-defined functions are necessary, you can remove the ones you don't want.
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rails_script/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/generators/rails_script/controller/controller_generator.rb

@@ -0,0 +1,27 @@
+module RailsScript
+  module Generators
+    class ControllerGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+      argument :controller_name, type: :string, default: ''
+      hook_for :controller
+
+      def generate_file
+        if controller_name.blank?
+          Rails.application.eager_load!
+          controllers = ApplicationController.descendants.map(&:to_s)
+          controllers.each{ |c| c.gsub!('Controller', '') }
+        else
+          controllers = [controller_name]
+        end
+
+        controllers.each do |controller|
+          if !File.exist?("app/assets/javascripts/#{controller.underscore}.js.coffee")
+            template 'javascript.js.coffee', "app/assets/javascripts/#{controller.underscore}.js.coffee"
+            gsub_file "app/assets/javascripts/#{controller.underscore}.js.coffee", 'Example', controller.gsub('::', '')
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/generators/rails_script/controller/templates/javascript.js.coffee

@@ -0,0 +1,22 @@
+window.App ||= {}
+class App.Example extends App.Base
+
+  constructor: ->
+    super
+    return this
+
+
+  index: ->
+    return
+
+
+  show: ->
+    return
+
+
+  new: ->
+    return
+
+
+  edit: ->
+    return

data/lib/generators/rails_script/install/install_generator.rb

@@ -0,0 +1,50 @@
+module RailsScript
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_files
+        template 'base.js.coffee', 'app/assets/javascripts/base.js.coffee'
+        template 'global.js.coffee', 'app/assets/javascripts/global.js.coffee'
+      end
+
+      def insert_load_order
+        if File.exist?('app/assets/javascripts/application.js')
+          inject_into_file 'app/assets/javascripts/application.js',  "\n//= require base", before: "\n//= require_tree ."
+        elsif File.exist?('app/assets/javascripts/application.js.coffee')
+          inject_into_file 'app/assets/javascripts/application.js.coffee', "\n#= require base", before: "\n#= require_tree ."
+        end
+      end
+
+      def create_controllers
+        generate 'rails_script:controller'
+      end
+
+      def insert_layout_javascript
+        say <<-RUBY
+In order to complete installation, you must add the following JavaScript snippet before the CLOSING body tag in your application layout.
+
+ERB:
+<script>
+jQuery(function() {
+    window.$this = new (App.\#{controller_path.split(/\/|_/).map(&:capitalize).join('')} || App.Base)();
+    if (typeof $this.\#{action_name} === 'function') {
+      return $this.\#{action_name}.call();
+    }
+});
+</script>
+
+HAML:
+:javascript
+  jQuery(function() {
+    window.$this = new (App.\#{controller_path.split(/\/|_/).map(&:capitalize).join('')} || App.Base)();
+    if (typeof $this.\#{action_name} === 'function') {
+      return $this.\#{action_name}.call();
+    }
+  });
+        RUBY
+      end
+
+    end
+  end
+end

data/lib/generators/rails_script/install/templates/base.js.coffee

@@ -0,0 +1,15 @@
+window.App ||= {}
+class App.Base
+
+  constructor: ->
+    return this
+
+
+  create: ->
+    $this.new()
+    return
+
+
+  update: ->
+    $this.edit()
+    return

data/lib/generators/rails_script/install/templates/global.js.coffee

@@ -0,0 +1 @@
+window.App ||= {}

data/lib/rails_script.rb

@@ -0,0 +1,5 @@
+require 'rails_script/version'
+require 'rails_script/railtie' if defined?(Rails)
+
+module RailsScript
+end

data/lib/rails_script/railtie.rb

@@ -0,0 +1,7 @@
+module RailsScript
+  class Railtie < Rails::Railtie
+    config.app_generators do |g|
+      g.templates.unshift File::expand_path('../../templates', __FILE__)
+    end
+  end
+end

data/lib/rails_script/version.rb

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

data/lib/templates/coffee/assets/javascript.js.coffee

@@ -0,0 +1,22 @@
+window.App ||= {}
+class App.<%= class_name  %> extends App.Base
+
+  constructor: ->
+    super
+    return this
+
+
+  index: ->
+    return
+
+
+  show: ->
+    return
+
+
+  new: ->
+    return
+
+
+  edit: ->
+    return

data/rails_script.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_script/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rails-script'
+  spec.version       = RailsScript::VERSION
+  spec.authors       = ['Kevin Pheasey']
+  spec.email         = ['kevin.pheasey@gmail.com']
+  spec.summary       = %q{A Rails-centric, object oriented, featherweight framework for writting CoffeeScript}
+  spec.description   = %q{Rails Script is a Rails-centric, object oriented, featherweight framework for writting CoffeeScript. It is optomized for the Rails Asset Pipeline and is compatible with TurboLinks. Using Rails controller names and actions to call JavaScript, it has never been easier to write clean, concise, and maintanable page specific JavaScript.}
+  spec.homepage      = 'https://github.com/gemgento/rails_script'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\u0000")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 0'
+
+  spec.add_runtime_dependency 'coffee-rails', '~> 4.0', '>= 4.0.0'
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: rails-script
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kevin Pheasey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: Rails Script is a Rails-centric, object oriented, featherweight framework
+  for writting CoffeeScript. It is optomized for the Rails Asset Pipeline and is compatible
+  with TurboLinks. Using Rails controller names and actions to call JavaScript, it
+  has never been easier to write clean, concise, and maintanable page specific JavaScript.
+email:
+- kevin.pheasey@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/rails_script/controller/USAGE
+- lib/generators/rails_script/controller/controller_generator.rb
+- lib/generators/rails_script/controller/templates/javascript.js.coffee
+- lib/generators/rails_script/install/USAGE
+- lib/generators/rails_script/install/install_generator.rb
+- lib/generators/rails_script/install/templates/base.js.coffee
+- lib/generators/rails_script/install/templates/global.js.coffee
+- lib/rails_script.rb
+- lib/rails_script/railtie.rb
+- lib/rails_script/version.rb
+- lib/templates/coffee/assets/javascript.js.coffee
+- rails_script.gemspec
+homepage: https://github.com/gemgento/rails_script
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A Rails-centric, object oriented, featherweight framework for writting CoffeeScript
+test_files: []