angular_sprinkles 0.2.14 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dff2c0fdcd7737a0adcce73fb1ce61386b3c0b42
-  data.tar.gz: d333af388f0a7ccfbe56f3824e8336b01a5cacf6
+  metadata.gz: d2ca75f5bc2cc8cdd98f994baec30cccf119ab8c
+  data.tar.gz: 39b1c5dfaff4c05c824ec7372573e74010b0474c
 SHA512:
-  metadata.gz: 3cacd67c49ae9ea243664e5ba9b40bc5a8192a6a38767e12f99c9d10b3c6bf4478ea200a7e9d2f87ee69499ef9be9eca221039219cdeddc5e9233ca0a1f002af
-  data.tar.gz: 3b5557d45d3b8904e28ecb59929829e7ea5090c1fa5d8afec07a8c043b9d033e14bd01ab02f74b135b3af94b91cb1f08eb9cfd0ce1eef0712b09a74528988090
+  metadata.gz: 2cb89f9dcca04611c218c3057d2bfd23cc29862e06ac51f9da227ed54bb29a553fafc7ace16add21bccdb89f83e2d91c7762c47895d36385ed31e06d6e79f678
+  data.tar.gz: dd63bd3d015ac50937a6aeebca8e143e382849264ceaf69d800ec72113b013921da62e5fd73cdfc3eddc810f2ace3da09d48a1f3631b0aa760ccc20fe7d730ca

data/README.md

@@ -42,6 +42,7 @@ Include and `angular_sprinkles` into your `application.js`.
 
 - [Two-way binding](#two-way-binding)
 - [Directives](#directives)
+- [Controllers and Isolate Scopes](#controllers-and-isolate-scopes)
 - [Inlining function calls](#inlining-function-calls)
 - [Form helpers](#form-helpers)
 
@@ -79,6 +80,60 @@ sprinkles.directive('blink', function () {
 <% end %>
 ```
 
+Directives can also return it's controller to a ruby block if the directive uses transclusion.
+
+```erb
+<script>
+sprinkles.directive('someDirective', function () {
+  return {
+    transclude: true,
+    template: '<div ng-transclude></div>',
+    // note: 'controllerAs' must be the directive name + 'Ctrl'
+    controllerAs: 'someDirectiveCtrl',
+    controller: function () {
+      this.alertMe = function (name) {
+        alert('Hi, ' + name);
+      };
+    }
+  }
+});
+</script>
+
+<%= directive(:someDirective) do |some_ctrl| %>
+  <button ng-click="<%= some_ctrl.call('Gabe') %>">CLICK ME!</button>
+<% end %>
+```
+
+### Controllers and Isolate Scopes
+
+If you would rather skip the directive and just create a controller, there is the `ctrl` helper.
+
+```erb
+<script>
+sprinkles.controller('someCtrl', function () {
+  this.alertMe = function (name) {
+    alert('Hi, ' + name);
+  };
+});
+</script>
+
+<%= ctrl(:someCtrl) do |some_ctrl| %>
+  <button ng-click="<%= some_ctrl.call('Gabe') %>">CLICK ME!</button>
+<% end %>
+```
+
+This is good for localizing JavaScript behavior. Additionally, if you'd just like to create a new
+scope, you can use the `isolate` helper which creates an "anonymous" controller to wrap your element.
+
+```erb
+<%= isolate do |iso_ctrl| %>
+  <input ng-model="<%= iso_ctrl.bind(:isolated_binding) %>">
+  {{ <%= iso_ctrl.bind(:isolated_binding) %> }}
+<% end %>
+```
+
+In contrast with the `bind` helper, bindings made here do not apply to the scope of the root controller.
+
 ### Inlining function calls
 
 Call services directly from the view with the `service` helper.

data/VERSION

@@ -1 +1 @@
-0.2.14
+0.3.0

data/angular_sprinkles.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: angular_sprinkles 0.2.14 ruby lib
+# stub: angular_sprinkles 0.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "angular_sprinkles"
-  s.version = "0.2.14"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Gabe Scholz"]
-  s.date = "2014-10-19"
+  s.date = "2014-10-22"
   s.description = "Add a few sprinkles of AngularJS to your Rails App"
   s.email = "gabe@brewhouse.io"
   s.extra_rdoc_files = [
@@ -35,11 +35,10 @@ Gem::Specification.new do |s|
     "lib/angular_sprinkles/content_yielder.rb",
     "lib/angular_sprinkles/context.rb",
     "lib/angular_sprinkles/counter.rb",
-    "lib/angular_sprinkles/directive/attributes.rb",
-    "lib/angular_sprinkles/directive/controller.rb",
-    "lib/angular_sprinkles/directive/html.rb",
-    "lib/angular_sprinkles/directive/input.rb",
-    "lib/angular_sprinkles/directive/name.rb",
+    "lib/angular_sprinkles/element/attributes.rb",
+    "lib/angular_sprinkles/element/html.rb",
+    "lib/angular_sprinkles/element/input.rb",
+    "lib/angular_sprinkles/element/scope.rb",
     "lib/angular_sprinkles/engine.rb",
     "lib/angular_sprinkles/form_binder/base.rb",
     "lib/angular_sprinkles/form_binder/check_box.rb",
@@ -47,7 +46,10 @@ Gem::Specification.new do |s|
     "lib/angular_sprinkles/helpers.rb",
     "lib/angular_sprinkles/helpers/bind_form_for_helper.rb",
     "lib/angular_sprinkles/helpers/bind_helper.rb",
+    "lib/angular_sprinkles/helpers/controller_helper.rb",
     "lib/angular_sprinkles/helpers/directive_helper.rb",
+    "lib/angular_sprinkles/helpers/element_helper.rb",
+    "lib/angular_sprinkles/helpers/isolate_helper.rb",
     "lib/angular_sprinkles/helpers/service_helper.rb",
     "lib/angular_sprinkles/java_script.rb",
     "lib/angular_sprinkles/key_generator.rb",
@@ -62,11 +64,10 @@ Gem::Specification.new do |s|
     "spec/angular_sprinkles/content_yielder_spec.rb",
     "spec/angular_sprinkles/context_spec.rb",
     "spec/angular_sprinkles/counter_spec.rb",
-    "spec/angular_sprinkles/directive/attributes_spec.rb",
-    "spec/angular_sprinkles/directive/controller_spec.rb",
-    "spec/angular_sprinkles/directive/html_spec.rb",
-    "spec/angular_sprinkles/directive/input_spec.rb",
-    "spec/angular_sprinkles/directive/name_spec.rb",
+    "spec/angular_sprinkles/element/attributes_spec.rb",
+    "spec/angular_sprinkles/element/html_spec.rb",
+    "spec/angular_sprinkles/element/input_spec.rb",
+    "spec/angular_sprinkles/element/scope_spec.rb",
     "spec/angular_sprinkles/form_binder/base_spec.rb",
     "spec/angular_sprinkles/form_binder/check_box_spec.rb",
     "spec/angular_sprinkles/form_binder/default_spec.rb",

data/lib/angular_sprinkles.rb

@@ -2,11 +2,10 @@ require "angular_sprinkles/cache"
 require "angular_sprinkles/constructor"
 require "angular_sprinkles/constructor_collection"
 require "angular_sprinkles/content_yielder"
-require "angular_sprinkles/directive/attributes"
-require "angular_sprinkles/directive/controller"
-require "angular_sprinkles/directive/input"
-require "angular_sprinkles/directive/name"
-require "angular_sprinkles/directive/html"
+require "angular_sprinkles/element/attributes"
+require "angular_sprinkles/element/html"
+require "angular_sprinkles/element/input"
+require "angular_sprinkles/element/scope"
 require "angular_sprinkles/context"
 require "angular_sprinkles/counter"
 require "angular_sprinkles/engine"
@@ -15,7 +14,10 @@ require "angular_sprinkles/form_binder/check_box"
 require "angular_sprinkles/form_binder/default"
 require "angular_sprinkles/helpers/bind_form_for_helper"
 require "angular_sprinkles/helpers/bind_helper"
+require "angular_sprinkles/helpers/controller_helper"
 require "angular_sprinkles/helpers/directive_helper"
+require "angular_sprinkles/helpers/element_helper"
+require "angular_sprinkles/helpers/isolate_helper"
 require "angular_sprinkles/helpers/service_helper"
 require "angular_sprinkles/helpers"
 require "angular_sprinkles/java_script"

data/lib/angular_sprinkles/{directive → element}/attributes.rb

@@ -1,5 +1,5 @@
 module AngularSprinkles
-  module Directive
+  module Element
     class Attributes
       def initialize(args, options)
         @args = args

data/lib/angular_sprinkles/{directive → element}/html.rb

@@ -1,5 +1,5 @@
 module AngularSprinkles
-  module Directive
+  module Element
     class Html
       def initialize(args)
         @args = (args || {}).symbolize_keys

data/lib/angular_sprinkles/{directive → element}/input.rb

@@ -1,5 +1,5 @@
 module AngularSprinkles
-  module Directive
+  module Element
     class Input
       def initialize(args)
         @args = (args || {})

data/lib/angular_sprinkles/{directive/controller.rb → element/scope.rb}

@@ -1,19 +1,19 @@
 module AngularSprinkles
-  module Directive
-    class Controller
+  module Element
+    class Scope
       def initialize(args)
-        @name = args.fetch(:name)
+        @base = args.fetch(:base)
         @object_wrapper = args.fetch(:object_wrapper)
         @bind_json_wrapper = args.fetch(:bind_json_wrapper)
         @call_json_wrapper = args.fetch(:call_json_wrapper)
       end
 
       def bind(attribute = nil)
-        @object_wrapper.new(@name, attribute, @bind_json_wrapper)
+        @object_wrapper.new(@base, attribute, @bind_json_wrapper)
       end
 
       def call(function, *input)
-        @object_wrapper.new(@name, function, input, @call_json_wrapper)
+        @object_wrapper.new(@base, function, input, @call_json_wrapper)
       end
     end
   end

data/lib/angular_sprinkles/helpers.rb

@@ -2,7 +2,10 @@ module AngularSprinkles
   module Helpers
     include BindFormForHelper
     include BindHelper
+    include ControllerHelper
     include DirectiveHelper
+    include ElementHelper
+    include IsolateHelper
     include ServiceHelper
   end
 end

data/lib/angular_sprinkles/helpers/controller_helper.rb

@@ -0,0 +1,13 @@
+module AngularSprinkles
+  module Helpers
+    module ControllerHelper
+      def ctrl(controller_name, opts = {}, &block)
+        options = opts.dup.symbolize_keys
+
+        options['ng-controller'] = "#{controller_name} as #{controller_name}"
+        options[:scope_name] ||= controller_name
+        _element(options, &block)
+      end
+    end
+  end
+end

data/lib/angular_sprinkles/helpers/directive_helper.rb

@@ -1,25 +1,12 @@
 module AngularSprinkles
   module Helpers
     module DirectiveHelper
-      def directive(directive_name, options = {}, &block)
-        if block_given?
-          controller = Directive::Controller.new({
-            name: "#{directive_name}Ctrl",
-            object_wrapper: ObjectKeyWrapper,
-            bind_json_wrapper: JavaScript::NoOp,
-            call_json_wrapper: JavaScript::BindService
-          })
+      def directive(directive_name, opts = {}, &block)
+        options = opts.dup.symbolize_keys
 
-          content = capture(controller, &block)
-        end
-
-        name = Directive::Name.new(directive_name)
-        input = Directive::Input.new(options.except(:html))
-        html = Directive::Html.new(options[:html])
-
-        attributes = Directive::Attributes.new([name, input, html], tag: html.tag, content: content)
-
-        content_tag(*attributes.to_content_tag)
+        options[directive_name] = ""
+        options[:scope_name] ||= "#{directive_name}Ctrl"
+        _element(options, &block)
       end
     end
   end

data/lib/angular_sprinkles/helpers/element_helper.rb

@@ -0,0 +1,31 @@
+module AngularSprinkles
+  module Helpers
+    module ElementHelper
+      def _element(opts = {}, &block)
+        options = opts.dup.symbolize_keys
+
+        scope_name = options.delete(:scope_name)
+        html_options = options.delete(:html) || {}
+        input_options = options # use remaining options
+
+        if block_given?
+          scope = Element::Scope.new({
+            base: scope_name,
+            object_wrapper: ObjectKeyWrapper,
+            bind_json_wrapper: JavaScript::NoOp,
+            call_json_wrapper: JavaScript::BindService
+          })
+
+          content = capture(scope, &block)
+        end
+
+        input = Element::Input.new(input_options)
+        html = Element::Html.new(html_options)
+
+        attributes = Element::Attributes.new([input, html], tag: html.tag, content: content)
+
+        content_tag(*attributes.to_content_tag)
+      end
+    end
+  end
+end

data/lib/angular_sprinkles/helpers/isolate_helper.rb

@@ -0,0 +1,13 @@
+module AngularSprinkles
+  module Helpers
+    module IsolateHelper
+      def isolate(opts = {}, &block)
+        controller_name = "isolate_#{SecureRandom.hex}"
+        isolate_controller = ObjectKeyWrapper.new(controller_name, JavaScript::IsolateController)
+
+        @_sprinkles.content_yielder.call(isolate_controller)
+        ctrl(controller_name, opts, &block)
+      end
+    end
+  end
+end

data/lib/angular_sprinkles/java_script.rb

@@ -81,5 +81,9 @@ module AngularSprinkles
     NoOp = ->(*args) do
       args.flatten.compact.join('.')
     end
+
+    IsolateController = ->(name) do
+      "sprinkles.controller('#{name}', angular.noop);"
+    end
   end
 end

data/spec/angular_sprinkles/{directive → element}/attributes_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe AngularSprinkles::Directive::Attributes do
+describe AngularSprinkles::Element::Attributes do
   let(:something) { double(attributes: {}) }
   let(:name) { something }
   let(:input) { something }

data/spec/angular_sprinkles/{directive → element}/html_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe AngularSprinkles::Directive::Html do
+describe AngularSprinkles::Element::Html do
   let(:args) { { key: 'value', tag: 'a' } }
 
   subject { described_class.new(args) }

data/spec/angular_sprinkles/{directive → element}/input_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-describe AngularSprinkles::Directive::Input do
+describe AngularSprinkles::Element::Input do
   let(:args) { { "key" => value } }
 
   subject { described_class.new(args) }

data/spec/angular_sprinkles/{directive/controller_spec.rb → element/scope_spec.rb}

@@ -1,14 +1,14 @@
 require 'spec_helper'
 
-describe AngularSprinkles::Directive::Controller do
-  let(:name) { double }
+describe AngularSprinkles::Element::Scope do
+  let(:base) { double }
   let(:object_wrapper) { double }
   let(:bind_json_wrapper) { double }
   let(:call_json_wrapper) { double }
 
   subject do
     described_class.new({
-      name: name,
+      base: base,
       object_wrapper: object_wrapper,
       bind_json_wrapper: bind_json_wrapper,
       call_json_wrapper: call_json_wrapper
@@ -16,23 +16,23 @@ describe AngularSprinkles::Directive::Controller do
   end
 
   describe "#bind" do
-    it "wraps the controller name" do
+    it "wraps the controller base" do
       attribute = double
 
-      expect(object_wrapper).to receive(:new).with(name, attribute, bind_json_wrapper)
+      expect(object_wrapper).to receive(:new).with(base, attribute, bind_json_wrapper)
       subject.bind(attribute)
 
-      expect(object_wrapper).to receive(:new).with(name, nil, bind_json_wrapper)
+      expect(object_wrapper).to receive(:new).with(base, nil, bind_json_wrapper)
       subject.bind
     end
   end
 
   describe "#call" do
-    it "wraps the controller name" do
+    it "wraps the controller base" do
       function = double
       input = [double, double]
 
-      expect(object_wrapper).to receive(:new).with(name, function, input, call_json_wrapper)
+      expect(object_wrapper).to receive(:new).with(base, function, input, call_json_wrapper)
       subject.call(function, *input)
     end
   end

data/spec/dummy/app/assets/javascripts/application.js

@@ -47,3 +47,7 @@ sprinkles.directive('nestedDirective', function () {
     template: '<h2>{{name}}</h2>'
   };
 });
+
+sprinkles.controller('someCtrl', function () {
+  this.someValue = 42;
+});

data/spec/dummy/app/views/test/javascript_bindings.html.erb

@@ -9,6 +9,15 @@
   <%= directive(:nested_directive, name: @model.bind(:name), html: { tag: 'h1' }) %>
 <% end %>
 
+<%= ctrl(:someCtrl, html: { id: "ctrl-div" }) do |some_ctrl| %>
+  {{ <%= some_ctrl.bind(:someValue) %> }}
+<% end %>
+
+<%= isolate do |some_ctrl| %>
+  <div ng-init="<%= some_ctrl.bind(:someValue) %> = 42"></div>
+  <div id="isolate-div" ng-bind="<%= some_ctrl.bind(:someValue) %>"></div>
+<% end %>
+
 <div id="model-bind">
   <label for="input">Input</label>
   <input id="input" name="input" type="text" ng-model="<%= @model.bind(:name) %>" />

data/spec/features/javascript_bindings_spec.rb

@@ -28,5 +28,7 @@ feature "javascript_bindings", js: true do
     # directive controller results
     expect(find("#directive-ctrl-bind")).to have_content("bigHelloWorldCtrlAttribute")
     expect(find("#directive-ctrl-call")).to have_content('func result')
+    expect(find("#ctrl-div")).to have_content(42)
+    expect(find("#isolate-div")).to have_content(42)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: angular_sprinkles
 version: !ruby/object:Gem::Version
-  version: 0.2.14
+  version: 0.3.0
 platform: ruby
 authors:
 - Gabe Scholz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-19 00:00:00.000000000 Z
+date: 2014-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -82,11 +82,10 @@ files:
 - lib/angular_sprinkles/content_yielder.rb
 - lib/angular_sprinkles/context.rb
 - lib/angular_sprinkles/counter.rb
-- lib/angular_sprinkles/directive/attributes.rb
-- lib/angular_sprinkles/directive/controller.rb
-- lib/angular_sprinkles/directive/html.rb
-- lib/angular_sprinkles/directive/input.rb
-- lib/angular_sprinkles/directive/name.rb
+- lib/angular_sprinkles/element/attributes.rb
+- lib/angular_sprinkles/element/html.rb
+- lib/angular_sprinkles/element/input.rb
+- lib/angular_sprinkles/element/scope.rb
 - lib/angular_sprinkles/engine.rb
 - lib/angular_sprinkles/form_binder/base.rb
 - lib/angular_sprinkles/form_binder/check_box.rb
@@ -94,7 +93,10 @@ files:
 - lib/angular_sprinkles/helpers.rb
 - lib/angular_sprinkles/helpers/bind_form_for_helper.rb
 - lib/angular_sprinkles/helpers/bind_helper.rb
+- lib/angular_sprinkles/helpers/controller_helper.rb
 - lib/angular_sprinkles/helpers/directive_helper.rb
+- lib/angular_sprinkles/helpers/element_helper.rb
+- lib/angular_sprinkles/helpers/isolate_helper.rb
 - lib/angular_sprinkles/helpers/service_helper.rb
 - lib/angular_sprinkles/java_script.rb
 - lib/angular_sprinkles/key_generator.rb
@@ -109,11 +111,10 @@ files:
 - spec/angular_sprinkles/content_yielder_spec.rb
 - spec/angular_sprinkles/context_spec.rb
 - spec/angular_sprinkles/counter_spec.rb
-- spec/angular_sprinkles/directive/attributes_spec.rb
-- spec/angular_sprinkles/directive/controller_spec.rb
-- spec/angular_sprinkles/directive/html_spec.rb
-- spec/angular_sprinkles/directive/input_spec.rb
-- spec/angular_sprinkles/directive/name_spec.rb
+- spec/angular_sprinkles/element/attributes_spec.rb
+- spec/angular_sprinkles/element/html_spec.rb
+- spec/angular_sprinkles/element/input_spec.rb
+- spec/angular_sprinkles/element/scope_spec.rb
 - spec/angular_sprinkles/form_binder/base_spec.rb
 - spec/angular_sprinkles/form_binder/check_box_spec.rb
 - spec/angular_sprinkles/form_binder/default_spec.rb

data/lib/angular_sprinkles/directive/name.rb

@@ -1,19 +0,0 @@
-module AngularSprinkles
-  module Directive
-    class Name
-      def initialize(*names)
-        @names = names.flatten.map { |name| name.to_s.underscore.dasherize }
-      end
-
-      def attributes
-        { data: to_empty_hash }
-      end
-
-      private
-
-      def to_empty_hash
-        Hash[@names.product([''])]
-      end
-    end
-  end
-end

data/spec/angular_sprinkles/directive/name_spec.rb

@@ -1,11 +0,0 @@
-require 'spec_helper'
-
-describe AngularSprinkles::Directive::Name do
-  let(:args) { [:first, :second, :third] }
-
-  subject { described_class.new(args) }
-
-  it 'turns the args hash into an empty data hash' do
-    expect(subject.attributes).to eq({ data: { "first" => '', "second" => '', "third" => '' } })
-  end
-end