rails_script 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de3fe1e20520d3125d8c02b2d9f4681e5c840de2
-  data.tar.gz: c356853b2af063bf9ae9f1ccf8152599c7603e19
+  metadata.gz: e1158eac848d3653884eb4a115085124d41cb56a
+  data.tar.gz: 8fa77658f9637b99cc3dc770c271c640ccd3c4f6
 SHA512:
-  metadata.gz: 8e7b9c229aec1887b80f2318dfea2c164101bacf802fb8d93dbb78524dfd6d1fd356590d165eca8356bc5419c53a4856901d0a26c0c3ea9d3f4af03a2fa48bd8
-  data.tar.gz: b5c492541e160b797d1ac4dbc788433c6c304b2e917a0b5cddeca39f13b89fdaa6a3342e3c41fd8baed1ce8fee943ae10ea75e9039d5ccf0e9d33e643aa61a90
+  metadata.gz: b9e718d2fc47235da59cf1205528b494174e3f0269375099931eccd64240f4000e400458b12a6e3b524ea2db60f81a5c2d2f47d01a7fd6513cd060b7dd33c1d9
+  data.tar.gz: 45a80a07e93adbc9da211fb5c6dbc5770c8e3047ac0dfac0eca2f34bbe746de27b16f1a405a618f4bc1c897876d048fa6adaf690d953aef4b2d0254ab4313e6a

data/README.md

@@ -105,7 +105,129 @@ class App.Base
 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
+### Utilities
+
+A ```Utility``` is a class that will be used to create similar functionality in many areas of the application.  A good example of this is a Modal, which could appear multiple times on the same page.  So, let's encapsulate this functionality in a highly reusable class.
+
+First, generate the ```Utility```
+
+    $ rails g rails_script:utility Modal
+    
+This will create the following in ```/app/assets/javascripts/utilities/modal.js.coffee```:
+
+```
+# /app/assets/javascripts/utilities/modal.js.coffee
+window.App ||= {}
+window.App.Utility ||= {}
+class App.Utility.Modal
+    
+    constructor: ->
+        return this
+```
+
+Let's add some basic functionality:
+
+```
+# /app/assets/javascripts/utilities/modal.js.coffee
+window.App ||= {}
+window.App.Utility ||= {}
+class App.Utility.Modal
+    @element
+    @trigger
+    @isOpen = false
+    
+    constructor: ($element, $trigger) ->
+        @element = $element
+        @trigger = $trigger
+        @trigger.on 'click', @toggle
+        return this
+        
+    
+    toggle: (event) =>
+        event.preventDefault()
+        if @isShowing then @close() else @open()
+        
+    
+    open: =>
+        @isShowing = true
+        @element.show()
+        
+    
+    close: =>
+        @isShowing = false
+        @element.fadeOut('fast')
+```
+
+Now, here's how we use the utility from ```users#show```
+
+```
+# app/assets/javascripts/users.js.coffee
+
+window.App ||= {}
+class App.Users extends App.Base
+
+   show: ->
+        @galleryModal = new App.Utility.Modal($('#user-gallery-modal-wrapper'), $('user-gallery-modal-toggle-button'))
+
+```
+
+
+### Elements
+
+An ```Element``` is a class that describes the funcionality of a one off element in the applicattion.  A Main Menu is a good example of this since there is usually only a single Main Menu.
+
+First generate the ```Element```
+
+    $ rails g rails_script:element MainMenu
+    
+This will create the following in ```/app/assets/javascripts/elements/main_menu.js.coffee```
+
+```
+# /app/assets/javascripts/elements/main_menu.js.coffee```
+
+window.App.Element ||= {}
+class App.Element.MainMenu
+
+    constructor: ->
+        return this
+```
+
+We can now add all the logic for the main menu in a separate class and call it on every page like so:
+
+```
+# app/assets/javascripts/base.js.coffee
+
+window.App ||= {}
+class App.Base
+
+  constructor: ->
+    App.mainMenu = new App.Element.MainMenu()
+    return this
+```
+
+
+#### Element Inheritance
+
+Inheritance is another key tool for reusability.  Let's say our ```Element.MainMenu``` opens and closes in the same way as the ```Utility.Modal```.  Well then MainMenu should just extend Modal, this can be accomplished from the generator:
+
+    $ rails g rails:script MainMenu Modal
+    
+Which generates:
+
+````
+# /app/assets/javascripts/elements/main_menu.js.coffee
+
+window.App.Element ||= {}
+class App.Element.MainMenu extends App.Utility.Modal
+
+    constructor: ->
+        return this
+````
+    
+Inheritance from the generator can only come from a Utility class.  Any class you wish to extend should be created as a Utility.  The installer adds the line ```//= require_tree ./utilities``` before loading tree to handle this.  If you have a utility that extends a utility, then make sure the extended utility is loaded first by explicitly requiring it before ```//= require_tree ./utilities```.
+
+
+### 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:
 
@@ -143,6 +265,28 @@ class App.SomeNewController extends App.Base
 None of the pre-defined functions are necessary, you can remove the ones you don't want.
 
 
+### Generic Classes
+
+To generate a generic class that isn't a Utility, Element or Controller, just use the following:
+
+    $ rails g rails_script:class My::ClassName
+    
+Which generates:
+
+```
+# /app/assets/javascripts/my/class_name.js.coffee
+
+window.App ||= {}
+class App.MyClassName
+    
+    constructor: ->
+        return this
+
+```
+
+
+
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/rails_script/fork )

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

@@ -0,0 +1,14 @@
+module RailsScript
+  module Generators
+    class ElementGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+      argument :element_name, type: :string
+      argument :utility, type: :string, default: ''
+
+      def generate_file
+        template 'javascript.js.coffee', "app/assets/javascripts/elements/#{element_name.underscore}.js.coffee"
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+window.App ||= {}
+window.App.Element ||= {}
+class App.Element.<%= element_name.gsub('::', '') %> <%= "extends App.Utility.#{utility.gsub('::', '')}" unless utility.blank?  %>
+
+  constructor: ->
+    super
+    return this

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

@@ -8,11 +8,27 @@ module RailsScript
         template 'global.js.coffee', 'app/assets/javascripts/global.js.coffee'
       end
 
+      def create_directories
+        directory 'utilities/', 'app/assets/javascripts/utilities'
+        directory 'elements/', 'app/assets/javascripts/elements'
+      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 ."
+
+          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", before: "\n//= require_tree ."
+          else
+            append_file 'app/assets/javascripts/application.js',  "\n//= require base\n//= require_tree ./utilities\n//= require_tree ."
+          end
+
         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 ."
+
+          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", before: "\n#= require_tree ."
+          else
+            append_file 'app/assets/javascripts/application.js.coffee',  "\n#= require base\n#= require_tree ./utilities\n#= require_tree ."
+          end
         end
       end
 

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

@@ -0,0 +1,7 @@
+window.App ||= {}
+window.App.Utility ||= {}
+class App.Utility.<%= utility_name.gsub('::', '') %>
+
+  constructor: ->
+    super
+    return this

data/lib/generators/rails_script/utility/utility_generator.rb

@@ -0,0 +1,13 @@
+module RailsScript
+  module Generators
+    class UtilityGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+      argument :utility_name, type: :string
+
+      def generate_file
+        template 'javascript.js.coffee', "app/assets/javascripts/utilities/#{utility_name.underscore}.js.coffee"
+      end
+
+    end
+  end
+end

data/lib/rails_script/version.rb

@@ -1,3 +1,3 @@
 module RailsScript
-  VERSION = '0.0.7'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_script
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.0
 platform: ruby
 authors:
 - Kevin Pheasey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-14 00:00:00.000000000 Z
+date: 2014-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -79,10 +79,16 @@ files:
 - 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/element/USAGE
+- lib/generators/rails_script/element/element_generator.rb
+- 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/global.js.coffee
+- 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/loader_helper.rb
 - lib/rails_script/railtie.rb