joosy 0.1.0.alpha → 1.0.0.RC1

data/app/assets/javascripts/joosy/preloaders/caching.js.coffee

@@ -0,0 +1,169 @@
+#
+# Preloader for libraries with localStorage cache
+#
+# @note The `start` callback will only be called if loading required. 
+#   While working with cache, `complete` is the only callback that will be triggered.
+#
+# @example Basic usage
+#   libraries = [['/test1.js', 100], ['/test2.js', 500]] #100, 500 - size in bytes
+#   
+#   CachingPreloader.load libraries,
+#     start:    -> console.log 'preloading started'
+#     progress: (percent) -> console.log "#{percent}% loaded"
+#     complete: -> console.log 'preloading finished'
+#
+# @mixin
+#
+@CachingPreloader =
+  #
+  # If set to true, localStorage cache will be avoided
+  #
+  force: false
+  
+  #
+  # Prefix for localStorage keys
+  #
+  prefix: "cache:"
+  
+  #
+  # Number of libraries have been loaded (increases after lib was loaded)
+  #
+  counter: 0
+  
+  #
+  # Loads (or takes from cache) set of libraries using xhr and caches them in localStorage
+  # See class description for example of usage
+  #
+  # @param [Array] 2-levels array of libraries URLs i.e. [['/test1.js', 10],['/test2.js', 20]]
+  #   Second param of inner level is a size of script in bytes. Can be undefined.
+  # @param [Hash] Available options:
+  #   * start: `() -> null` to call before load starts
+  #   * progress: `(int percents) -> null` to call each 100ms of load in progress
+  #   * complete: `() -> null` to call after load completes
+  #
+  load: (libraries, options={}) ->
+    @[key] = val for key, val of options
+    @libraries = libraries.slice()
+
+    for lib, i in @libraries
+      @libraries[i] = @prefix+lib[0]
+
+    if !@force && @check()
+      @restore()
+    else
+      @start?.call window
+      @clean()
+      @download libraries
+
+  #
+  # Checks if we can load libraries or have to download them over
+  #
+  check: ->
+    flag = true
+    for name, i in @libraries
+      flag &&= window.localStorage.getItem(name)?
+    flag
+
+  #
+  # Escapes non-printable terminal chars before storing to localStorage to prevent IE bug
+  #
+  # @param [String] String, that will be prepared for localStorage
+  #
+  escapeStr: (str) ->
+    str.replace(new RegExp("\u0001", 'g'), "\\u0001").replace(new RegExp("\u000B", 'g'), "\\u000B")
+
+  #
+  # Gets sources of scripts from localStorage and evals them
+  #
+  restore: ->
+    for name, i in @libraries
+      window.evalGlobaly window.localStorage.getItem name
+    @complete?.call window, true
+
+  #
+  # Loads set of libraries using xhr and caches them in localStorage
+  #
+  # @param [Array] 2-levels array of libraries URLs i.e. [['/test1.js', 100],['/test2.js', 500]]
+  #   Second param of inner level is a size of script in bytes. Can be undefined.
+  #
+  download: (libraries) ->
+    if libraries.length > 0
+      @counter += 1
+
+      lib  = libraries.shift()
+      url  = lib[0]
+      size = lib[1]
+
+      @ajax url, size, (xhr) =>
+        code = xhr.responseText
+        if window.navigator.appName == "Microsoft Internet Explorer"
+          code = @escapeStr code
+        window.localStorage.setItem @prefix+url, code
+        window.evalGlobaly xhr.responseText
+        @download libraries
+    else
+      @complete?.call window
+
+  #
+  # Runs XHR request to get single script body
+  # Binds poller to call @progress each 100ms if possible (not IE *doh*)
+  #
+  # @param [String] URL to download from
+  # @param [Float] Expected size of download (to calculate percents)
+  #   Size can not be taken from headers since we are supposed to get gziped content
+  # @param [Function] `(xhr) -> null` to call after script was loaded
+  #
+  ajax: (url, size, callback) ->
+    if window.XMLHttpRequest
+      x = new XMLHttpRequest
+    else
+      x = new ActiveXObject 'Microsoft.XMLHTTP'
+
+    x.open 'GET', url, 1
+
+    x.onreadystatechange = () =>
+      if x.readyState > 3
+        clearInterval @interval
+        callback? x
+
+    if @progress
+      poller = =>
+        try
+          @progress.call window, Math.round((x.responseText.length / size) * (@counter / @libraries.length) * 100)
+        catch e
+          # ... IE?
+
+      @interval = setInterval poller, 100
+
+    x.send()
+
+  #
+  # Searches through localStorage for outdated entries with our prefix and removes them
+  #
+  clean: ->
+    i = 0
+    
+    find = (arr, obj) ->
+      (return i if obj == x) for x in arr
+      return -1
+
+    while i < window.localStorage.length && key = window.localStorage.key(i)
+      if key.indexOf(@prefix) == 0 && find(@libraries, key) < 0
+        window.localStorage.removeItem key
+      else
+        i += 1
+
+#
+# Evals source at a global scope
+# Don't touch it! It should be window's property, or FF3.6 will execute scripts on preloader context.
+#
+# @param [String] JS source to execute
+#
+window.evalGlobaly = (src) ->
+  return if src.length == 0
+  if window.execScript
+    window.execScript src
+  else
+    window.eval src
+
+@Preloader = @CachingPreloader

data/app/assets/javascripts/joosy/preloaders/inline.js.coffee

@@ -0,0 +1,56 @@
+#
+# Preloader for libraries using `script src` without any caching magic
+#
+# @example Basic usage
+#   libraries = [['/test1.js'], ['/test2.js']]
+#   
+#   InlinePreloader.load libraries,
+#     start:    -> console.log 'preloading started'
+#     complete: -> console.log 'preloading finished'
+#
+# @mixin
+#
+@InlinePreloader =
+  #
+  # Loads set of libraries by adding `script src` to DOM head 
+  # See class description for example of usage
+  #
+  # @param [Array] 2-levels array of libraries URLs i.e. [['/test1.js'],['/test2.js']]
+  # @param [Hash] Available options:
+  #   * start: `() -> null` to call before load starts: 
+  #   * complete: `() -> null` to call after load completes
+  #
+  load: (libraries, options) ->    
+    @[key] = val for key, val of options
+    @start?()
+
+    if libraries.length > 0
+      @receive libraries.shift()[0], => @load(libraries)
+    else
+      @complete?()
+
+  #
+  # Loads one script by adding `script src` to DOM head
+  #
+  # @param [String] url to load script from
+  # @param [Function] `() -> null` to call after script was loaded and executed
+  #
+  receive: (url, callback) ->
+    head   = document.getElementsByTagName("head")[0]
+    script = document.createElement "script"
+    script.src = url
+
+    done = false
+
+    proceed = ->
+      if !done && (!@readyState? || @readyState == "loaded" || @readyState == "complete")
+        done = true
+        callback?()
+        script.onload = script.onreadystatechange = null
+
+    script.onload = script.onreadystatechange = proceed
+
+    head.appendChild script
+    return undefined
+
+@Preloader = @InlinePreloader

data/{vendor → app}/assets/javascripts/joosy.js.coffee

@@ -3,5 +3,4 @@
 #= require jquery.hashchange
 #= require jquery.form
 #= require sugar
-#= require inflection
 #= require_tree ./joosy/core

data/app/helpers/joosy/sprockets_helper.rb

@@ -1,14 +1,41 @@
-module Joosy
-  module SprocketsHelper
-    def extract_sources_and_sizes_from_include_tag(name)
-      code = javascript_include_tag name
-      resources = code.scan(/(?:href|src)=['"]([^'"]+)['"]/).flatten
-
-      resources.map do |resource|
-        path = ::Rails.root.to_s + "/public" + resource.split('?')[0]
-        size = File.size(path) rescue false
-        [resource, size]
-      end.to_json.html_safe
+require 'uri'
+
+module Joosy::SprocketsHelper
+  def extract_sources_and_sizes_from_include_tag(name)
+    code = javascript_include_tag name
+    resources = code.scan(/(?:href|src)=['"]([^'"]+)['"]/).flatten
+
+    resources.map do |resource|
+      uri  = URI.parse resource
+      path = ::Rails.root.to_s + "/public" + uri.path
+      size = File.size(path) rescue 0
+      [resource, size]
+    end.to_json.html_safe
+  end
+
+  def require_joosy_preloader_for(app_asset, options={})
+    preloader_asset = "joosy/preloaders/#{options[:preloader] || 'caching'}"
+    force_preloader = options[:force] || false
+
+    if force_preloader
+      require_asset preloader_asset
+    else
+      require_asset Rails.env == 'development' ? app_asset : preloader_asset
+    end
+  end
+
+  def self.joosy_resources(namespaces=nil)
+    predefined = {}
+    filtered_resources = Joosy::Rails::Engine.resources
+    if namespaces
+      namespaces = Array.wrap namespaces
+      filtered_resources = filtered_resources.select{|key, _| namespaces.include? key }
+    end
+    filtered_resources.each do |namespace, resources|
+      next unless resources && resources.size > 0
+      joosy_namespace = namespace.to_s.camelize.split('::').join('.')
+      predefined[joosy_namespace] = resources
     end
+    predefined
   end
-end
+end

data/joosy.gemspec

@@ -6,19 +6,20 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.summary     = "Joosy Framework support for Ruby on Rails"
   s.email       = "boris@roundlake.ru"
-  s.homepage    = "http://github.com/roundlake/joosy-rails"
+  s.homepage    = "http://github.com/roundlake/joosy"
   s.description = "A gem wrapper to include Joosy via the asset pipeline."
   s.authors     = ['Boris Staal', 'Andrew Shaydurov', 'Peter Zotov', 'Alexander Pavlenko']
 
   s.files         = `git ls-files`.split("\n")
   s.require_paths = ["lib"]
 
-  s.add_dependency 'rails', ">= 3.0.0"
+  s.add_dependency 'rails', ">= 3.1.0"
   s.add_dependency 'coffee-rails'
   s.add_dependency 'jquery-rails'
+  s.add_dependency 'haml_coffee_assets'
+  s.add_dependency 'i18n-js'
 
   s.add_development_dependency 'guard'
-  s.add_development_dependency 'guard-shell'
   s.add_development_dependency 'guard-coffeescript'
   s.add_development_dependency 'guard-sprockets'
   s.add_development_dependency 'jasmine'

data/lib/joosy/rails/engine.rb

@@ -3,7 +3,18 @@ require 'rails/engine'
 module Joosy
   module Rails
     class Engine < ::Rails::Engine
-      # auto wire
+
+      cattr_accessor :resources
+      self.resources = {}
+
+      initializer 'joosy.extend.sprockets' do |app|
+        ActiveSupport.on_load(:action_view) do
+          app.assets.context_class.instance_eval do
+            include ::Joosy::SprocketsHelper
+          end
+        end
+      end
+
     end
   end
 end

data/lib/joosy/rails/version.rb

@@ -1,5 +1,5 @@
 module Joosy
   module Rails
-    VERSION = "0.1.0.alpha"
+    VERSION = "1.0.0.RC1"
   end
-end
+end

data/lib/joosy.rb

@@ -0,0 +1,9 @@
+require 'haml_coffee_assets'
+require 'jquery-rails'
+require 'coffee-rails'
+
+require 'joosy/rails/engine'
+require 'joosy/rails/version'
+require 'rails/resources_with_joosy'
+
+require 'i18n-js'

data/lib/rails/generators/joosy/application_generator.rb

@@ -6,24 +6,36 @@ module Joosy
       source_root File.join(File.dirname(__FILE__), 'templates')
 
       def create_files
-        self.destination_root = "app/assets/javascripts"
+        super
 
         template "app.js.coffee", "#{file_path}.js.coffee"
 
+        template "app_resources_predefiner.js.coffee.erb", "#{file_path}_resources_predefiner.js.coffee.erb"
+
         empty_directory file_path
 
         template "app/routes.js.coffee", "#{file_path}/routes.js.coffee"
 
+        empty_directory "#{file_path}/helpers"
+        template "app/helpers/application.js.coffee", "#{file_path}/helpers/application.js.coffee"
+
         empty_directory "#{file_path}/layouts"
         template "app/layouts/application.js.coffee", "#{file_path}/layouts/application.js.coffee"
 
-        empty_directory "#{file_path}/pages"
+        empty_directory "#{file_path}/pages/welcome"
         template "app/pages/application.js.coffee", "#{file_path}/pages/application.js.coffee"
+        template "app/pages/welcome/index.js.coffee", "#{file_path}/pages/welcome/index.js.coffee"
+
+        empty_directory "#{file_path}/templates/layouts"
+        template "app/templates/layouts/application.jst.hamlc", "#{file_path}/templates/layouts/application.jst.hamlc"
+
+        empty_directory "#{file_path}/templates/pages/welcome"
+        template "app/templates/pages/welcome/index.jst.hamlc", "#{file_path}/templates/pages/welcome/index.jst.hamlc"
 
         empty_directory_with_gitkeep "#{file_path}/widgets"
+        empty_directory_with_gitkeep "#{file_path}/resources"
 
         empty_directory_with_gitkeep "#{file_path}/templates/layouts"
-        empty_directory_with_gitkeep "#{file_path}/templates/pages"
         empty_directory_with_gitkeep "#{file_path}/templates/widgets"
       end
     end

data/lib/rails/generators/joosy/joosy_base.rb

@@ -3,8 +3,8 @@ require 'rails/generators/named_base'
 module Rails
   module Generators
     class JoosyBase < ::Rails::Generators::NamedBase
-      class_option :template_kind, :type => :string, :aliases => "-T", :default => 'jade',
-                                   :desc => "Generate templates with specified extension (default: .jade)"
+      class_option :template_kind, :type => :string, :aliases => "-T", :default => 'hamlc',
+                                   :desc => "Generate templates with specified extension (default: .hamlc)"
 
       class_option :skip_git,      :type => :boolean, :aliases => "-G", :default => false,
                                    :desc => "Skip Git keeps"

data/lib/rails/generators/joosy/layout_generator.rb

@@ -18,7 +18,14 @@ module Joosy
       protected
 
       def app_path
-        File.join class_path
+        unless class_path.size == 1
+          puts <<HELP
+Usage: rails generate joosy:layout joosy_app_name/layout_name
+Tip: do not add Layout suffix to layout_name
+HELP
+          exit 1
+        end
+        class_path[0]
       end
     end
   end

data/lib/rails/generators/joosy/page_generator.rb

@@ -8,21 +8,36 @@ module Joosy
       def create_files
         super
 
-        empty_directory "#{app_path}/pages"
-        template "app/pages/template.js.coffee", "#{app_path}/pages/#{layout_name}/#{file_name}.js.coffee"
+        empty_directory "#{app_path}/pages/#{namespace_path}"
+        template "app/pages/template.js.coffee", "#{app_path}/pages/#{namespace_path}/#{file_name}.js.coffee"
 
-        empty_directory "#{app_path}/templates/pages/#{layout_name}"
-        create_file "#{app_path}/templates/pages/#{layout_name}/#{file_name}.jst.#{options[:template_kind]}"
+        empty_directory "#{app_path}/templates/pages/#{namespace_path}"
+        create_file "#{app_path}/templates/pages/#{namespace_path}/#{file_name}.jst.#{options[:template_kind]}"
       end
 
       protected
 
       def app_path
-        File.join class_path[0..-2]
+        if class_path.size < 2
+          puts <<HELP
+Usage: rails generate joosy:page joosy_app_name/page_namespace/page_name
+Tip: do not add Page suffix to page_name
+HELP
+          exit 1
+        end
+        class_path[0]
+      end
+
+      def namespace_path
+        File.join class_path[1..-1]
+      end
+
+      def namespace_name
+        class_path[1..-1].map(&:camelize).join '.'
       end
 
       def layout_name
-        class_path.last
+        class_path[1]
       end
     end
   end

data/lib/rails/generators/joosy/preloader_generator.rb

@@ -4,21 +4,28 @@ module Joosy
   module Generators
     class PreloaderGenerator < ::Rails::Generators::NamedBase
       class_option :template_engine, :type => :string,
-                                     :desc => "Generate templates for specified engine."
+        :desc => "Generate templates for specified engine."
 
       source_root File.join(File.dirname(__FILE__), 'templates')
 
       def create_preloader_files
-        template "app_preloader.js.coffee.erb", "app/assets/javascripts/#{file_path}_preloader.js.coffee.erb"
+        unless class_path.empty?
+          puts <<HELP
+Usage: rails generate joosy:preloader joosy_app_name
+HELP
+          exit 1
+        end
 
-        empty_directory "app/controllers/#{File.join class_path}"
-        template "app_controller.rb", "app/controllers/#{file_path}_controller.rb"
+        template "app_preloader.js.coffee.erb", "app/assets/javascripts/#{file_name}_preloader.js.coffee.erb"
 
-        empty_directory "app/views/layouts/#{File.join class_path}"
+        empty_directory "app/controllers"
+        template "app_controller.rb", "app/controllers/#{file_name}_controller.rb"
+
+        empty_directory "app/views/layouts"
         template "preload.html.#{options[:template_engine]}",
-                 "app/views/layouts/#{file_path}.html.#{options[:template_engine]}"
+                 "app/views/layouts/#{file_name}.html.#{options[:template_engine]}"
 
-        route "match '#{file_path}' => '#{file_path}#index'"
+        route "match '#{file_name}' => '#{file_name}#index'"
       end
     end
   end

data/lib/rails/generators/joosy/resource_generator.rb

@@ -0,0 +1,29 @@
+require 'rails/generators/joosy/joosy_base'
+
+module Joosy
+  module Generators
+    class ResourceGenerator < ::Rails::Generators::JoosyBase
+      source_root File.join(File.dirname(__FILE__), 'templates')
+
+      def create_files
+        super
+
+        empty_directory "#{app_path}/resources"
+        template "app/resources/template.js.coffee", "#{app_path}/resources/#{file_name}.js.coffee"
+      end
+
+      protected
+
+      def app_path
+        unless class_path.size == 1
+          puts <<HELP
+Usage: rails generate joosy:resource joosy_app_name/resource_name
+Tip: resource_name is better to be singular
+HELP
+          exit 1
+        end
+        class_path[0]
+      end
+    end
+  end
+end

data/lib/rails/generators/joosy/templates/app/helpers/application.js.coffee

@@ -0,0 +1,4 @@
+Joosy.helpers 'Application', ->
+  
+  # helloWorld = (name) ->
+  #   "Hello World, #{name}"

data/lib/rails/generators/joosy/templates/app/layouts/application.js.coffee

@@ -1 +1,2 @@
 class @ApplicationLayout extends Joosy.Layout
+  @view 'application'

data/lib/rails/generators/joosy/templates/app/layouts/template.js.coffee

@@ -1,2 +1,2 @@
 class @<%= file_name.camelize %>Layout extends ApplicationLayout
-  view: JST['<%= app_path %>/templates/layouts/<%= file_name %>']
+  @view '<%= file_name %>'

data/lib/rails/generators/joosy/templates/app/pages/application.js.coffee

@@ -1 +1 @@
-class @ApplicationPage extends Joosy.Page
+class @ApplicationPage extends Joosy.Page

data/lib/rails/generators/joosy/templates/app/pages/template.js.coffee

@@ -1,5 +1,5 @@
-Joosy.namespace '<%= layout_name.camelize %>', ->
+Joosy.namespace '<%= namespace_name %>', ->
 
   class @<%= file_name.camelize %>Page extends ApplicationPage
-    layout: <%= layout_name.camelize %>Layout
-    view: JST['<%= app_path %>/templates/pages/<%= layout_name %>/<%= file_name %>']
+    @layout ApplicationLayout
+    @view   '<%= file_name %>'

data/lib/rails/generators/joosy/templates/app/pages/welcome/index.js.coffee

@@ -0,0 +1,22 @@
+Joosy.namespace 'Welcome', ->
+
+  class @IndexPage extends ApplicationPage
+    @layout ApplicationLayout
+    @view   'index'
+    
+    @afterLoad ->
+      @startHeartbeat()
+      @content.css 
+        'padding-top': "#{$(window).height() / 2 - 160}px"
+    
+    elements:
+      content: '#content'
+      joosy:   '.joosy'
+
+    events:
+      'mouseover $joosy': -> clearInterval @heartbeat
+      'mouseout $joosy': 'startHeartbeat'
+      
+    startHeartbeat: ->
+      @heartbeat = @setInterval 1500, =>
+        @joosy.animate({opacity: 0.8}, 300).animate({opacity: 1}, 300)

data/lib/rails/generators/joosy/templates/app/resources/template.js.coffee

@@ -0,0 +1,2 @@
+class @<%= file_name.camelize %> extends Joosy.Resource.REST
+  @entity '<%= file_name %>'

data/lib/rails/generators/joosy/templates/app/routes.js.coffee

@@ -1,2 +1,8 @@
 Joosy.Router.map
-  404             : (path) -> alert "Page '#{path}' was not found :("
+  404             : (path) -> alert "Page '#{path}' was not found :("
+  '/'             : Welcome.IndexPage
+# '/resources'    :
+#   '/'           : Resource.IndexPage
+#   '/:id'        : Resource.ShowPage
+#   '/:id/edit'   : Resource.EditPage
+#   '/new'        : Resource.EditPage

data/lib/rails/generators/joosy/templates/app/templates/layouts/application.jst.hamlc

@@ -0,0 +1,2 @@
+#page{:style => 'font-family: "Lucida Grande", "Verdana"; text-align: center'}
+  .content{:id => @yield()}

data/lib/rails/generators/joosy/templates/app/templates/pages/welcome/index.jst.hamlc

@@ -0,0 +1,7 @@
+#wrapper
+  #content
+    %h1 Welcome aboard
+    %h2{:style => 'margin-bottom: 30px'} You’re still riding Ruby on Rails.
+    .joosy{:style => 'background: #F71; border-radius: 10px; width: 250px; display: inline-block'}
+      %div{:style => 'color: #FFF; padding: 10px;'}
+        But it's so joosy this time!

data/lib/rails/generators/joosy/templates/app/widgets/template.js.coffee

@@ -1,2 +1,2 @@
-class @<%= file_name.camelize %>Widget extends Joosy.Layout
-  view: JST['<%= app_path %>/templates/widgets/<%= file_name %>']
+class @<%= file_name.camelize %>Widget extends Joosy.Widget
+  @view '<%= file_name %>'

data/lib/rails/generators/joosy/templates/app.js.coffee

@@ -1,6 +1,10 @@
+#= require hamlcoffee
 #= require joosy
 #
+#= require_tree ./<%= file_name %>/helpers
 #= require_tree ./<%= file_name %>/templates
+#= require_tree ./<%= file_name %>/resources
+#= require      ./<%= file_name %>_resources_predefiner
 #= require_tree ./<%= file_name %>/widgets
 #= require_tree ./<%= file_name %>/layouts
 #= require_tree ./<%= file_name %>/pages

data/lib/rails/generators/joosy/templates/app_preloader.js.coffee.erb

@@ -1,16 +1,13 @@
-<%= '<% require_asset "joosy/preloader/#{Rails.env}" %'+'>' %>
+<%= "<%= require_joosy_preloader_for '" %><%= file_name %><%= "', preloader: 'caching', force: false %" + ">" %>
 
 bootstrap = ->
-  $('#preloader').slideUp ->
-    location.hash = '!/' if !location.hash
-    
-    Joosy.debug = window.preload.development
-    Joosy.Application.initialize('#application')
+  $('#preloader').remove()
+  Joosy.Application.initialize '<%= file_name %>','#application',
+    environment: window.joosy.environment
+    debug: false
 
 window.onload = ->
-  Preloader.force    = false
-  Preloader.complete = bootstrap
-  Preloader.start    = -> document.getElementById('preloader').style.display = 'block'
-  Preloader.progress = (percent) -> document.getElementById('percents').innerHTML = percent + '%'
-
-  Preloader.load window.preload.libraries
+  Preloader.load window.joosy.libraries,
+    complete: bootstrap
+    start: -> document.getElementById('preloader').style.display = 'block'
+    progress: (percent) -> document.getElementById('percents').innerHTML = percent + '%'