shuriken 0.1.0

data/README.md

@@ -0,0 +1,36 @@
+# Shuriken #
+## Pointy javascript namespace helpers and stuff ##
+
+Shuriken is a lightweight toolset for Javascript, written in coffeescript
+that provides a lightweight implementation of namespaces and a few other things
+(e.g. mixins) that I've found have simplified structured javascript development.
+
+Using it is as simple as including the shuriken.js in your app and writing your code:
+
+    // declare BHM as a root namespace.
+    var BHM = Shuriken.as('BHM');
+    
+    // Should print out true.
+    console.log(BHM instanceof Shuriken.Namespace);
+    
+    BHM.withNS('Something', function(ns) {
+      
+      ns.hello = true;
+      
+      ns.sayHello = function() {
+        if(ns.hello) console.log("Hello there!");
+      };
+      
+      ns.setup = function() {
+        ns.sayHello();
+      };
+      
+    });
+
+    // On document load, unless BHM.autosetup is false,
+    // BHM.Something.setup() will be automatically called.
+    // Also,
+    BHM.Something.sayHello();
+    // will say hello manually. I'm sure you get the picture by now.
+
+

data/Rakefile

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'rake'
+
+require 'lib/shuriken'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name        = "shuriken"
+    gem.summary     = %Q{Simple Namespace support for JS + Other niceties, packaged as a Barista framework}
+    gem.description = %Q{Simple Namespace support for JS + Other niceties, packaged as a Barista framework}
+    gem.email       = "sutto@sutto.net"
+    gem.homepage    = "http://github.com/Sutto/shuriken"
+    gem.version     = Shuriken::VERSION
+    gem.authors     = ["Darcy Laycock"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/coffeescripts/shuriken/mixins/callbacks.coffee

@@ -0,0 +1,23 @@
+Shuriken.defineExtension (baseNS) ->
+  baseNS.defineMixin 'Callbacks', (mixin) ->
+
+    mixin.callbacks: {}
+
+    mixin.defineCallback: (key) ->
+      @["on$key"]:     (callback) -> @hasCallback key, callback
+      @["invoke$key"]: (args...)  -> @invokeCallbacks key, args...
+      true
+
+    mixin.hasCallback: (name, callback) ->
+      callbacks: mixin.callbacks[name]?= []
+      callbacks.push callback
+      true
+
+    mixin.callbacksFor: (name) ->
+      existing: mixin.callbacks[name]
+      if existing? then existing else []
+
+    mixin.invokeCallbacks: (name, args...) ->
+      for callback in mixin.callbacksFor(name)
+        return false if callback(args...) is false
+      true

data/coffeescripts/shuriken/mixins.coffee

@@ -0,0 +1,41 @@
+Shuriken.defineExtension (baseNS) ->
+  baseNS.withNS 'Mixins', (ns) ->
+  
+    root:        @getRootNS()
+    ns.mixins:   {}
+    root.mixins: {}
+
+    root.withBase (base) ->
+      base.mixin: (mixins) -> ns.mixin @, mixins
+
+    defineMixin: (key, mixin) ->
+      @mixins[key]: mixin
+
+    root.defineMixin: defineMixin
+    ns.define:       defineMixin
+
+    ns.lookupMixin: (mixin) ->
+      switch typeof mixin
+        when "string"
+          if ns.mixins[mixin]?
+            ns.mixins[mixin]
+          else if root.mixins[mixin]?
+            root.mixins[mixin]
+          else
+            {} # unknown mixin, return a blank object.
+        else
+          mixin
+
+    ns.invokeMixin: (scope, mixin) ->
+      switch typeof mixin
+        when "string"
+          ns.invokeMixin scope, ns.lookupMixin(mixin)
+        when "function"
+          mixin.call scope, scope
+        when "object"
+          $.extend scope, mixin
+
+    ns.mixin: (scope, mixins) ->
+      mixins: [mixins] unless $.isArray mixins
+      ns.invokeMixin scope, ns.lookupMixin(mixin) for mixin in mixins
+      true

data/coffeescripts/shuriken.coffee

@@ -0,0 +1,127 @@
+# First off, add our dataAttr extensions.
+if jQuery?
+  (($) ->
+    stringToDataKey:      (key) -> "data-$key".replace /_/g, '-'
+    $.fn.dataAttr: (key, value) -> @attr stringToDataKey(key), value
+    $.fn.removeDataAttr:  (key) -> @removeAttr stringToDataKey(key)
+    $.fn.hasDataAttr:     (key) -> @is "[${stringToDataKey(key)}]"
+    $.getMeta:            (key) -> $("meta[name='$key']").attr "content"
+  )(jQuery)
+
+
+Shuriken: {
+  Base:         {}
+  Util:         {}
+  jsPathPrefix: "/javascripts/"
+  jsPathSuffix: ""
+  namespaces:   {},
+  extensions:   []
+}
+
+Shuriken.Util.underscoreize: (s) ->
+  s.replace(/\./g, '/').replace(/([A-Z]+)([A-Z][a-z])/g, '$1_$2').replace(/([a-z\d])([A-Z])/g, '$1_$2').replace(/-/g, '_').toLowerCase()
+
+Shuriken.Util.scopedClosure: (closure, scope) ->
+  closure.call scope, scope if $.isFunction closure
+
+    
+# Base is the prototype for all namespaces.
+base: Shuriken.Base
+
+base.hasChildNamespace: (child) ->
+  @children.push child
+  
+base.toNSName: (children...) ->
+  parts: children
+  current: @
+  while current.parent?
+    parts.unshift parts
+    current: current.parent
+  parts.join "."
+  
+base.getNS: (namespace) ->
+  parts: key.split "."
+  currentNS: @
+  for name in parts
+    return unless currentNS[name]?
+    currentNS = currentNS[name]
+  currentNS
+  
+base.getRootNS: ->
+  current: @
+  current: current.parent while current.parent?
+  current
+
+base.hasNS: (namespace) ->
+  @getNS(namespace)?
+  
+base.withNS: (key, initializer) ->
+  parts: key.split "."
+  currentNS: @
+  for name in parts
+    currentNS[name] = makeNS(name, currentNS, @baseNS) if not currentNS[name]?
+    currentNS: currentNS[name]
+  hadSetup: $.isFunction currentNS.setup
+  Shuriken.Util.scopedClosure initializer, currentNS
+  currentNS.setupVia currentNS.setup if not hadSetup and $.isFunction currentNS.setup
+  currentNS
+
+base.withBase: (closure) ->
+  Shuriken.Util.scopedClosure closure, @baseNS
+
+base.isRoot: ->
+  not @parent?
+  
+base.log: (args...) ->
+  console.log "[${@toNSName()}]", args...
+  
+base.debug: (args...) ->
+  console.log "[Debug - ${@toNSName()}]", args...
+
+base.setupVia: (f) ->
+  $(document).ready => Shuriken.Util.scopedClosure(f, @) if @autosetup?
+  
+base.require: (key, callback) ->
+  ns: @getNS key
+  if ns?
+    Shuriken.Util.scopedClosure callback, ns
+  else
+    path:   Shuriken.Util.underscoreize "${@toNSName()}.$key"
+    url:    "${Shuriken.jsPathPrefix}${path}.js${Shuriken.jsPathSuffix}"
+    script: $ "<script />", {type: "text/javascript", src: url}
+    script.load -> Shuriken.Util.scopedClosure callback, @getNS(key)
+    script.appendTo $ "head"
+
+base.autosetup: true
+
+# Used as a part of the prototype chain.
+Shuriken.Namespace: ->  
+Shuriken.Namespace.prototype = Shuriken.Base;
+
+makeNS: (name, parent, sharedPrototype) ->
+   sharedPrototype?= new Shuriken.Namespace()
+   namespace: ->
+     @name:     name
+     @parent:   parent
+     @baseNS:   sharedPrototype
+     @children: []
+     parent.hasChildNamespace(@) if parent?
+     @
+    namespace.prototype: sharedPrototype
+    new namespace name, parent
+    
+Shuriken.defineExtension: (closure) ->
+  for namespace in Shuriken.namespaces
+    console.log namespace
+    Shuriken.Util.scopedClosure closure, namespace
+  Shuriken.extensions.push closure
+
+Shuriken.as: (name) ->
+  ns: makeNS name
+  Shuriken.namespaces[name]: ns
+  Shuriken.root[name]: ns
+  Shuriken.Util.scopedClosure extension, ns for extension in Shuriken.extensions
+  ns
+
+Shuriken.root: @
+@['Shuriken'] = Shuriken

data/lib/shuriken.rb

@@ -0,0 +1,11 @@
+module Shuriken
+  
+  VERSION = "0.1.0".freeze
+  
+  def self.register_framework!
+    Barista::Framework.register 'shuriken', File.expand_path('../coffeescripts', File.dirname(__FILE__))
+  end
+  
+  register_framework! if defined? Barista::Framework
+  
+end

data/shuriken.gemspec

@@ -0,0 +1,44 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{shuriken}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Darcy Laycock"]
+  s.date = %q{2010-05-03}
+  s.description = %q{Simple Namespace support for JS + Other niceties, packaged as a Barista framework}
+  s.email = %q{sutto@sutto.net}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "README.md",
+     "Rakefile",
+     "coffeescripts/shuriken.coffee",
+     "coffeescripts/shuriken/mixins.coffee",
+     "coffeescripts/shuriken/mixins/callbacks.coffee",
+     "lib/shuriken.rb",
+     "shuriken.gemspec",
+     "wip-coffeescripts/test.coffee"
+  ]
+  s.homepage = %q{http://github.com/Sutto/shuriken}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Simple Namespace support for JS + Other niceties, packaged as a Barista framework}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/wip-coffeescripts/test.coffee

@@ -0,0 +1,36 @@
+Shuriken.Test = {}
+
+((test) ->
+
+  class test.Context
+    
+    constructor: (name) ->
+      @name:   name
+      @blocks: {}
+    
+    blocksFor: (name) ->
+      @blocks[name]?= []
+      
+    invokeBlocksFor: (name) ->
+      block() for block in @blocksFor name
+    
+    run: ->
+      @invokeBlocksFor "beforeAll"
+      for test in blocksFor "tests"
+        @invokeBlocksFor "setup"
+        test.run()
+        @invokeBlocksFor "teardown"
+      @invokeBlocksFor "afterAll"
+      
+  class test.Test
+    
+    constructor: (name, body) ->
+      @name: name
+      @body: body
+      
+    run: ->
+      @body()
+      "Passed"
+      
+
+)(Shuriken.Test)

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: shuriken
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Darcy Laycock
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-03 00:00:00 +08:00
+default_executable: 
+dependencies: []
+
+description: Simple Namespace support for JS + Other niceties, packaged as a Barista framework
+email: sutto@sutto.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- README.md
+- Rakefile
+- coffeescripts/shuriken.coffee
+- coffeescripts/shuriken/mixins.coffee
+- coffeescripts/shuriken/mixins/callbacks.coffee
+- lib/shuriken.rb
+- shuriken.gemspec
+- wip-coffeescripts/test.coffee
+has_rdoc: true
+homepage: http://github.com/Sutto/shuriken
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Simple Namespace support for JS + Other niceties, packaged as a Barista framework
+test_files: []
+