rails_script 1.0.0 → 2.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTZhZGMyNDM2OWEyZTU5YmE4NjhkZDYxNmE3YmZlZDkxMjY1ZmIwZQ==
+    NWZmNTVhNzNhMDMzMmE1MzZjYmQ1OTRmNTU4ZmUzMWFhYzgxMjJiNQ==
   data.tar.gz: !binary |-
-    ZmMwMzJlMWVjNjEwZDE5N2U3ZmU0NTE5YWM5NGY1ZTUzYWFiZDYwNg==
+    MjI1ZjYwNmNkNjM0NjEwYmQwZTdmYjkwMTMzYmUxNDE2MTdhZWE5ZQ==
 SHA512:
   metadata.gz: !binary |-
-    N2VhZWFjOWQ4OGViMTI3YzQ1ODU4ZmU2YzdjY2Q5MGUxZDNhMjdjZWRkODA1
-    ZTJhMGQ3MjAzNWNiMjQzOGYyZjgyNmZjYzg4MDFkNGM3OWI2MmU2MmQ2Mzg2
-    NTlkZTJkY2JlM2ViZWQ4ZWQ5YzE1YzYxMDlkMmJkOTBhYzc4MDY=
+    NDE2MWI4YjI1N2EwYmFhOTRlN2Q3NzBmN2FkNmE3ZTk5ZTgwZTNiMzNjMTAw
+    NjVkY2Y5M2RhZWEyZmU0ZWY0NGIwNDVkMTEyNDJhNzA4YWNmN2VlZjFlNDRm
+    MGYyNThjMGVhZWEyODA3ZjljNmY4OWY1NDdhYzg2M2VkNmY2MTU=
   data.tar.gz: !binary |-
-    YjhmYjQ2NzVmZjE4NjIxZjBhNTg2OWMyYzM3NGQ4OTI2ZWI4MzBiNzJlNDc3
-    OGU3MDlmZDQwNWY2ZDg4MjE1Yzg3NTQxMGViYTIyNTcyMWIyMjVhN2U1MGZh
-    ZTY5ZTFlNzkwNzM1YzIwNDllMWJlY2Q1NDVlYTg1MGFiNjhkZmI=
+    OWM1MmQwYzBlZTZiNWM5ZDg3YmVlNTQ0ODAzODZiYjIzZmVjYTIzZGM2ODI2
+    OWQ4ZGFiOGE3NDI5MWI3YTRkNzE0MTVjZjAzZTI4OGJiMDM3MmViMGIzMmQ5
+    NTVmZDhjZWQxMzVkYmY1MTc3ZTM0NTA1NGE3NDE4OGJiM2JiMjM=

data/README.md

@@ -2,11 +2,15 @@
 
 RailsScript is a Rails-centric, object oriented, featherweight framework for writing CoffeeScript.  It is optimized 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 maintainable page specific JavaScript.
 
+## Upgrading to V2
+
+To migrate from version 0.x to 1.x, please see the wiki; https://github.com/gemgento/rails_script/wiki/v2-Migration
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'rails_script', '~> 0.6.1'
+    gem 'rails_script', '~> 2.0'
 
 And then execute:
 
@@ -24,9 +28,6 @@ After the generator finishes, you will be prompted to add helper call to your ap
 
 NOTE: Your JS files needed have been included before `include_rails_script`.  In other words, you still need `<%= javascript_include_tag "application" %>` in your application layout.
 
-## Configuration
-You can configure name of your application in config/initializers/rails_script.rb file.
-
 ## Usage
 
 ### Page (Action) Specific JavaScript
@@ -227,7 +228,7 @@ Inheritance from the generator can only come from a Utility class.  Any class yo
 
 ### Custom Controllers
 
-When a new controller is generated, the JavaScript asset file will be generated with RailsScript.  However, if you need to manually generate a RailsScript controller you can use:
+When a new controller is generated, the JavaScript asset file will be generated with App.  However, if you need to manually generate a RailsScript controller you can use:
 
     $ rails g rails_script:controller Some::NewController
     

data/app/assets/javascripts/base.coffee

@@ -0,0 +1,23 @@
+class App.Base
+
+  constructor: ->
+    if (window.jQuery) then RailsScript.setClearEventHandlers() # clearing application event handlers only possible with jQuery
+    return this
+
+
+  ###
+  Run the new action for the create action.  Generally the create action will 'render :new' if there was a problem.
+  This prevents doubling the code for each action.
+  ###
+  create: ->
+    if typeof $this.new == 'function'
+      return $this.new()
+
+
+  ###
+  Run the edit action for the update action.  Generally the update action will 'render :edit' if there was a problem.
+  This prevents doubling the code for each action.
+  ###
+  update: ->
+    if typeof $this.edit == 'function'
+      return $this.edit()

data/app/assets/javascripts/rails_script.coffee

@@ -0,0 +1,4 @@
+#= require rails_script/init
+#= require base
+#= require_tree ./utilities
+#= require_tree ./elements

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

@@ -1,4 +1,4 @@
-class <%= RailsScript.app_namespace %>.<%= class_name.gsub('::', '') %>
+class App.<%= class_name.gsub('::', '') %>
 
   constructor: ->
     return this

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

@@ -1,4 +1,4 @@
-class <%= RailsScript.app_namespace %>.<%= controller.gsub('::', '') %> extends <%= RailsScript.app_namespace %>.Base
+class App.<%= controller.gsub('::', '') %> extends App.Base
 
   beforeAction: (action) =>
     return

data/lib/generators/rails_script/element/element_generator.rb

@@ -1,7 +1,7 @@
 module RailsScript
   module Generators
     class ElementGenerator < ::Rails::Generators::Base
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.expand_path('../templates', __FILE__)
       argument :element_name, type: :string
       argument :utility, type: :string, default: ''
 

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

@@ -1,34 +1,28 @@
 module RailsScript
   module Generators
     class InstallGenerator < ::Rails::Generators::Base
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.expand_path("../../../../../app/assets/javascripts", __FILE__)
 
       def copy_files
-        template 'base.js.coffee', 'app/assets/javascripts/base.js.coffee'
-        template 'global.js.coffee', 'app/assets/javascripts/global.js.coffee'
-        template 'rails_script.rb', 'config/initializers/rails_script.rb'
-      end
-
-      def create_directories
-        directory 'utilities/', 'app/assets/javascripts/utilities'
-        directory 'elements/', 'app/assets/javascripts/elements'
+        template 'base.coffee', 'app/assets/javascripts/base.coffee'
+        template 'global.coffee', 'app/assets/javascripts/global.coffee'
       end
 
       def insert_load_order
         if File.exist?('app/assets/javascripts/application.js')
 
           if File.readlines('app/assets/javascripts/application.js').grep('//= require_tree .').any?
-            inject_into_file 'app/assets/javascripts/application.js',  "\n//= require base\n//= require_tree ./utilities\n//= require_tree ./elements", before: "\n//= require_tree ."
+            inject_into_file 'app/assets/javascripts/application.js',  "//= require rails_script\n", before: '//= require_tree .'
           else
-            append_file 'app/assets/javascripts/application.js',  "\n//= require base\n//= require_tree ./utilities\n//= require_tree ./elements\n//= require_tree ."
+            append_file 'app/assets/javascripts/application.js',  "\n//= require rails_script"
           end
 
         elsif File.exist?('app/assets/javascripts/application.js.coffee')
 
           if File.readlines('app/assets/javascripts/application.js.coffee').grep('#= require_tree .').any?
-            inject_into_file 'app/assets/javascripts/application.js.coffee', "\n#= require base\n#= require_tree ./utilities\n#= require_tree ./elements", before: "\n#= require_tree ."
+            inject_into_file 'app/assets/javascripts/application.js.coffee', "#= require rails_script\n", before: '#= require_tree .'
           else
-            append_file 'app/assets/javascripts/application.js.coffee',  "\n#= require base\n#= require_tree ./utilities\n#= require_tree ./elements\n#= require_tree ."
+            append_file 'app/assets/javascripts/application.js.coffee',  "\n#= require rails_script"
           end
         end
       end

data/lib/rails_script.rb

@@ -1,13 +1,9 @@
 require 'rails_script/version'
+require 'rails_script/engine'
 require 'rails_script/loader_helper'
 require 'rails_script/to_javascript'
 require 'rails_script/railtie' if defined?(Rails)
 
 module RailsScript
-  mattr_accessor :app_namespace
-  @@app_namespace = 'App'
-  
-  def self.config
-    yield self
-  end
+
 end

data/lib/rails_script/engine.rb

@@ -0,0 +1,4 @@
+module RailsScript
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/rails_script/loader_helper.rb

@@ -2,7 +2,11 @@ module RailsScript
   module LoaderHelper
 
     def include_rails_script
-      content_tag :div, nil, id: 'rails-script', data: { controller: controller_path.split(/\/|_/).map(&:capitalize).join(''), vars: @to_javascript.to_json }
+      content_tag :div, nil, id: 'rails-script', data: {
+          controller: controller_path.split(/\/|_/).map(&:capitalize).join(''),
+          action: action_name,
+          vars: @to_javascript.to_json
+      }
     end
 
   end

data/lib/rails_script/version.rb

@@ -1,3 +1,3 @@
 module RailsScript
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

data/vendor/assets/javascripts/rails_script/init.coffee

@@ -0,0 +1,25 @@
+window.RailsScript ||= {}
+window.App ||= {}
+window.Element ||= {}
+window.Utility ||= {}
+
+$(document).on "turbolinks:load.rails_script",  ->
+  Utility.RailsVars = $('#rails-script').data('vars')
+  window.$this = new (App["#{$('#rails-script').data('controller')}"] || App.Base)()
+
+  action = $('#rails-script').data('action')
+
+  if typeof $this.beforeAction == 'function'
+    $this.beforeAction action
+  if typeof $this[action] == 'function'
+    $this[action]()
+  if typeof $this.afterAction == 'function'
+    $this.afterAction action
+
+RailsScript.setClearEventHandlers = ->
+  jQuery(document).on 'turbolinks:before-visit', ->
+    for element in [window, document]
+      for event, handlers of (jQuery._data(element, 'events') || {})
+        for handler in handlers
+          if handler? && handler.namespace == ''
+            jQuery(element).off event, handler.handler

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_script
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Kevin Pheasey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-16 00:00:00.000000000 Z
+date: 2016-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,6 +73,11 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/assets/javascripts/base.coffee
+- app/assets/javascripts/elements/.keep
+- app/assets/javascripts/global.coffee
+- app/assets/javascripts/rails_script.coffee
+- app/assets/javascripts/utilities/.keep
 - lib/generators/rails_script/class/USAGE
 - lib/generators/rails_script/class/class_generator.rb
 - lib/generators/rails_script/class/templates/javascript.js.coffee
@@ -84,21 +89,18 @@ files:
 - lib/generators/rails_script/element/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/elements/.keep
-- lib/generators/rails_script/install/templates/global.js.coffee
-- lib/generators/rails_script/install/templates/rails_script.rb
-- lib/generators/rails_script/install/templates/utilities/.keep
 - lib/generators/rails_script/utility/USAGE
 - lib/generators/rails_script/utility/templates/javascript.js.coffee
 - lib/generators/rails_script/utility/utility_generator.rb
 - lib/rails_script.rb
+- lib/rails_script/engine.rb
 - lib/rails_script/loader_helper.rb
 - lib/rails_script/railtie.rb
 - lib/rails_script/to_javascript.rb
 - lib/rails_script/version.rb
-- lib/templates/coffee/assets/javascript.js.coffee
+- lib/templates/coffee/assets/javascript.coffee
 - rails_script.gemspec
+- vendor/assets/javascripts/rails_script/init.coffee
 homepage: https://github.com/kpheasey/rails_script
 licenses:
 - MIT

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

@@ -1,45 +0,0 @@
-window.<%= RailsScript.app_namespace %> ||= {}
-window.Element ||= {}
-window.Utility ||= {}
-
-$(document).on "turbolinks:load.rails_script",  ->
-  Utility.RailsVars = $('#rails-script').data('vars')
-  window.$this = new (<%= RailsScript.app_namespace %>["#{$('#rails-script').data('controller')}"] || <%= RailsScript.app_namespace %>.Base)()
-
-class <%= RailsScript.app_namespace %>.Base
-
-  constructor: ->
-    if (window.jQuery) then @setClearEventHandlers() # clearing application event handlers only possible with jQuery
-    return this
-
-
-  ###
-  Run the new action for the create action.  Generally the create action will 'render :new' if there was a problem.
-  This prevents doubling the code for each action.
-  ###
-  create: ->
-    if typeof $this.new == 'function'
-      return $this.new()
-
-
-  ###
-  Run the edit action for the update action.  Generally the update action will 'render :edit' if there was a problem.
-  This prevents doubling the code for each action.
-  ###
-  update: ->
-    if typeof $this.edit == 'function'
-      return $this.edit()
-
-
-  ###
-  Clear event handlers with a blank namespace.  This will prevent window and document event handlers from stacking
-  when each new page is fetched.  Adding a namespace to your events will prevent them from being removed between page
-  loads, i.e. "$(window).on 'scroll.app', myHandler"
-  ###
-  setClearEventHandlers: ->
-    jQuery(document).on 'page:before-change', ->
-      for element in [window, document]
-        for event, handlers of (jQuery._data(element, 'events') || {})
-          for handler in handlers
-            if handler? && handler.namespace == ''
-              jQuery(element).off event, handler.handler

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

@@ -1,4 +0,0 @@
-RailsScript.config do |c|
-  # Configure name that will be used to namespace the javascript classes
-  c.app_namespace = 'App'
-end