angular_sprinkles 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9f6308b16a728b1c5e29241e0e94be0eec1d3735
+  data.tar.gz: c1f09fbcc331e60afe3860ea39283b990e4e21dd
+SHA512:
+  metadata.gz: 7831c173521e159f22de88877f5796f65740dafb22578a3ec0bda94a7431fa7975a669093f1d06180c022b31c0b9ed808e83150a3c50cd1581b2deca35653fb5
+  data.tar.gz: 3b5cd766296c41a6ea3f08008e51356ca6470aad47b05b931339f1f808bcd4a8412d0723738eeea36d26122ee687e2ddf85b57caa4b7b01973e21882969ed371

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gem "rails"
+gem "actionview"
+gem "angularjs-rails" # must be greater than 1.2
+
+group :development do
+  gem "rspec"
+  gem "rdoc"
+  gem "bundler"
+  gem "jeweler"
+  gem "simplecov"
+  gem "byebug"
+end

data/Gemfile.lock

@@ -0,0 +1,156 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (4.1.4)
+      actionpack (= 4.1.4)
+      actionview (= 4.1.4)
+      mail (~> 2.5.4)
+    actionpack (4.1.4)
+      actionview (= 4.1.4)
+      activesupport (= 4.1.4)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.4)
+      activesupport (= 4.1.4)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.4)
+      activesupport (= 4.1.4)
+      builder (~> 3.1)
+    activerecord (4.1.4)
+      activemodel (= 4.1.4)
+      activesupport (= 4.1.4)
+      arel (~> 5.0.0)
+    activesupport (4.1.4)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    addressable (2.3.6)
+    angularjs-rails (1.2.21)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
+    byebug (3.2.0)
+      columnize (~> 0.8)
+      debugger-linecache (~> 1.2)
+    columnize (0.8.9)
+    debugger-linecache (1.2.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    erubis (2.7.0)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.8)
+    github_api (0.12.1)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.3)
+      oauth2
+    hashie (3.2.0)
+    highline (1.6.21)
+    hike (1.2.3)
+    i18n (0.6.11)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (1.0.0)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.25.1)
+    mini_portile (0.6.0)
+    minitest (5.4.0)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.3.1)
+      mini_portile (= 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    polyglot (0.3.5)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.1.4)
+      actionmailer (= 4.1.4)
+      actionpack (= 4.1.4)
+      actionview (= 4.1.4)
+      activemodel (= 4.1.4)
+      activerecord (= 4.1.4)
+      activesupport (= 4.1.4)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.1.4)
+      sprockets-rails (~> 2.0)
+    railties (4.1.4)
+      actionpack (= 4.1.4)
+      activesupport (= 4.1.4)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.3.2)
+    rdoc (4.1.1)
+      json (~> 1.4)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.4)
+    simplecov (0.9.0)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    sprockets (2.12.1)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.1.3)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionview
+  angularjs-rails
+  bundler
+  byebug
+  jeweler
+  rails
+  rdoc
+  rspec
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Gabe Scholz
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,153 @@
+# Angular Sprinkles
+
+Sprinkles is a Ruby on Rails gem for developers who want to use Angular's two most powerful features, two-way data binding and
+custom directives, without all of the regular setup required for a typical Angular-based application.
+
+Sprinkles injects just enough JavaScript onto your page to make you dangerous. It is intended to be used by developers who just
+want a sprinkle of Angular instead of a full-blown application.
+
+## Setup
+
+Add Angular and Sprinkles to your `Gemfile`
+
+```ruby
+# Gemfile
+
+gem 'angularjs-rails'
+gem 'angular_sprinkles'
+```
+
+Add a yield method for your sprinkles at the bottom of your body tag
+
+```erb
+<%=# app/views/layouts/application.html.erb %>
+<body>
+
+<%= yield %>
+
+<%= yield :sprinkles %>
+</body>
+```
+
+Include Angular and Sprinkles into your `application.js`
+
+```js
+// app/assets/javascripts/application.js
+
+//= require angular
+//= require angular_sprinkles
+//= require_tree .
+```
+
+That's it! You are now read to begin using Sprinkles in your application. There is no need to create an application module or
+controller. Sprinkles dynamically generates this for you.
+
+## Data binding
+
+Two-way data binding with Sprinkles is easy. We can use the `bind` view helper to create a binding between two elements
+
+```erb
+<%=# some view %>
+
+<span ng-bind="<%= bind(:user) %>"></span>
+<input type="text" ng-model="<%= bind(:user) %>" />
+```
+
+We can also create nested data structures and Sprinkles handles creating parent objects for us
+
+```erb
+<%=# some view %>
+
+Bind the entire object: <span ng-bind="<%= bind(:user) %>"></span>
+
+Full Name: <span ng-bind="<%= bind(:user, :first_name) %> + ' ' + <%= bind(:user, :last_name) %>"></span>
+First Name: <input type="text" ng-model="<%= bind(:user, :first_name) %>" />
+Last Name: <input type="text" ng-model="<%= bind(:user, :last_name) %>" />
+```
+
+This is okay, but it would be nice to inject some data that already exists. We will use the `bindable` controller helper to wrap our objects
+
+```ruby
+class UserController < ApplicationController
+  include AngularSprinkles::Controller
+
+  def show
+    @user = bindable(User.find(params[:id]))
+  end
+```
+
+Our user is now also able to use `bind`
+
+```erb
+<%=# some view %>
+
+Bind the entire object: <span ng-bind="<%= @user.bind %>"></span>
+
+Full Name: <span ng-bind="<%= @user.bind(:first_name) %>  + ' ' + <%= @user.bind(:last_name) %>"></span>
+First Name: <input type="text" ng-model="<%= @user.bind(:first_name) %>" />
+Last Name: <input type="text" ng-model="<%= @user.bind(:last_name) %>" />
+```
+
+We've got two-way data binding of persisted data without writing a single line of javascript!
+
+## Custom Directives
+
+Sprinkles also comes packaged with a helper for instantiating custom directives.
+
+In order to write custom directives, you must add them to the sprinkles module which is attached to the global `sprinkles` variable.
+Let's create an element that blinks some text.
+
+```js
+// some js file
+
+sprinkles.directive('blink', function ($interval) {
+  return {
+    restrict: 'A',
+    scope: {
+      interval: '=',
+      text: '='
+    },
+    template: '<span>{{text}}</span>',
+    link: function (scope, el) {
+      var opacity = 1;
+
+      scope.text = scope.text || 'Hello World!';
+      scope.interval = scope.interval || 1000;
+
+      $interval(function () {
+        el.css({ opacity: opacity });
+        opacity = -opacity + 1;
+      }, scope.interval);
+    }
+  }
+});
+```
+
+```erb
+<%=# some view %>
+
+<%= directive(:blink, { interval: 250, text: 'Blink Me!' }) %>
+```
+
+"Blink Me!" will now flash on the screen. We can also combine this directive with the `bind` helper so that we can change the text on the fly
+
+```erb
+<%=# some view %>
+
+<%= directive(:blink, { interval: 250, text: bind(:blink_text) }) %>
+<input type="text" ng-model="<%= bind(:blink_text) %>" />
+```
+
+## Including additional modules
+
+Adding additional modules is just a matter of appending them to `sprinkles.requires`. This is already a feature of Angular and not Sprinkles
+
+```js
+// some js file
+
+sprinkles.requires.push('ui.router');
+```
+
+## Copyright
+
+Copyright (c) 2014 Brewhouse Software. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "angular_sprinkles"
+  gem.homepage = "http://github.com/BrewhouseTeam/angular_sprinkles"
+  gem.license = "MIT"
+  gem.summary = %Q{Add few sprinkles of AngularJS to your Rails App}
+  gem.description = %Q{Add few sprinkles of AngularJS to your Rails App}
+  gem.email = "gabe@brewhouse.io"
+  gem.authors = ["Gabe Scholz"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['spec'].execute
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "angular_sprinkles #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/angular_sprinkles.gemspec

@@ -0,0 +1,94 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: angular_sprinkles 0.0.1 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "angular_sprinkles"
+  s.version = "0.0.1"
+
+  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-08-22"
+  s.description = "Add few sprinkles of AngularJS to your Rails App"
+  s.email = "gabe@brewhouse.io"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "angular_sprinkles.gemspec",
+    "app/assets/javascripts/angular_sprinkles.js.erb",
+    "lib/angular_sprinkles.rb",
+    "lib/angular_sprinkles/controller.rb",
+    "lib/angular_sprinkles/data/bind.rb",
+    "lib/angular_sprinkles/decorators.rb",
+    "lib/angular_sprinkles/decorators/bind_decorator.rb",
+    "lib/angular_sprinkles/engine.rb",
+    "lib/angular_sprinkles/helpers.rb",
+    "lib/angular_sprinkles/helpers/bind_helper.rb",
+    "lib/angular_sprinkles/helpers/directive_helper.rb",
+    "lib/angular_sprinkles/mixins/initializable.rb",
+    "lib/angular_sprinkles/mixins/js_transformable.rb",
+    "lib/angular_sprinkles/railtie.rb",
+    "spec/controller_spec.rb",
+    "spec/data/bind_spec.rb",
+    "spec/decorators/bind_decorator_spec.rb",
+    "spec/helpers/bind_helper_spec.rb",
+    "spec/helpers/directive_helper_spec.rb",
+    "spec/mixins/initializable_spec.rb",
+    "spec/mixins/js_transformable_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/BrewhouseTeam/angular_sprinkles"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.1"
+  s.summary = "Add few sprinkles of AngularJS to your Rails App"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, [">= 0"])
+      s.add_runtime_dependency(%q<actionview>, [">= 0"])
+      s.add_runtime_dependency(%q<angularjs-rails>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<byebug>, [">= 0"])
+    else
+      s.add_dependency(%q<rails>, [">= 0"])
+      s.add_dependency(%q<actionview>, [">= 0"])
+      s.add_dependency(%q<angularjs-rails>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<byebug>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rails>, [">= 0"])
+    s.add_dependency(%q<actionview>, [">= 0"])
+    s.add_dependency(%q<angularjs-rails>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<byebug>, [">= 0"])
+  end
+end
+

data/app/assets/javascripts/angular_sprinkles.js.erb

@@ -0,0 +1,18 @@
+//= require angular
+
+window.sprinkles = angular.module('<%= AngularSprinkles::APP_NAME %>', []);
+
+window.onload = function () {
+  var angular = window.angular,
+    app = angular.module('<%= AngularSprinkles::APP_NAME %>'),
+    doc = document.documentElement,
+    ctrlName = (doc.attributes['ng-controller'] || doc.attributes['data-ng-controller']) || 'Ctrl';
+
+  ctrlName = ctrlName.split(' as ')[0];
+
+  <%= AngularSprinkles::CONTROLLER_FN %> = <%= AngularSprinkles::CONTROLLER_FN %> || function(){};
+  app.controller(ctrlName, <%= AngularSprinkles::CONTROLLER_FN %>);
+  doc.setAttribute('data-ng-controller', ctrlName + ' as <%= AngularSprinkles::CONTROLLER_NAME %>');
+
+  angular.bootstrap(doc, [app.name]);
+};

data/lib/angular_sprinkles/controller.rb

@@ -0,0 +1,61 @@
+require 'angular_sprinkles/mixins/js_transformable'
+require 'angular_sprinkles/mixins/initializable'
+require 'angular_sprinkles/decorators/bind_decorator'
+
+module AngularSprinkles
+  module Controller
+    include AngularSprinkles::Mixins::JsTransformable
+    include AngularSprinkles::Mixins::Initializable
+
+    def bindable(object)
+      klass = object.class
+      key = "#{klass}_#{inc_sprinkles_counter(klass)}"
+      assignable(key => object)
+      AngularSprinkles::Decorators::Bind.new(object, key, method(:view_context))
+    end
+
+    def assignable(hash)
+      raise TypeError unless hash.is_a?(Hash)
+      declare_js_controller_prototype unless app_initialized?
+      preload_to_page(hash)
+    end
+
+    def view_context
+      @_sprinkles_view_context ||= super.tap do |view|
+        if sprinkles_content.any?
+          content = view.content_tag(:script, (sprinkles_content.join(";\n") + ';').html_safe)
+          view.content_for(:sprinkles, content)
+        end
+      end
+    end
+
+    private
+
+    def sprinkles_counter
+      @_sprinkles_counter ||= {}
+    end
+
+    def inc_sprinkles_counter(klass)
+      sprinkles_counter[klass] ||= 0
+      sprinkles_counter[klass] += 1
+    end
+
+    def declare_js_controller_prototype
+      sprinkles_content.push(AngularSprinkles::CONSTRUCTOR_DEFINITION)
+    end
+
+    def preload_to_page(hash)
+      hash.each do |var_name, value|
+        if !var_initialized?(var_name)
+          str = set_prototype_variable(var_name, value)
+          sprinkles_content.push(str)
+        end
+      end
+      sprinkles_content
+    end
+
+    def sprinkles_content
+      @_sprinkles_content ||= []
+    end
+  end
+end

data/lib/angular_sprinkles/data/bind.rb

@@ -0,0 +1,18 @@
+require 'angular_sprinkles/mixins/js_transformable'
+
+module AngularSprinkles
+  module Data
+    class Bind
+      include Mixins::JsTransformable
+
+      def initialize(*strs)
+        @strs = strs.flatten.compact
+      end
+
+      def to_json
+        to_ctrl_variable(@strs.join('.'))
+      end
+      alias_method :to_s, :to_json
+    end
+  end
+end

data/lib/angular_sprinkles/decorators/bind_decorator.rb

@@ -0,0 +1,53 @@
+module AngularSprinkles
+  module Decorators
+    class Bind < SimpleDelegator
+      def initialize(object, key, context_proc)
+        @_sprinkles_bind_wrapper = Wrapper.new(object, key, context_proc)
+        super(object)
+      end
+
+      def bind(_method = nil)
+        @_sprinkles_bind_wrapper.bind(_method)
+      end
+
+      private
+
+      class Wrapper
+        # create BindWrapper so that methods and variables don't pollute
+        # the object being wrapped by Bind
+
+        attr_reader :_object, :key, :context_proc
+
+        def initialize(object, key, context_proc)
+          @_object, @key, @context_proc = object, key, context_proc
+        end
+
+        def bind(_method = nil)
+          if _method.present? && !context.var_initialized?([key, _method])
+            set_prototype_variable_and_yield(_method)
+          end
+
+          context.bind(key, _method)
+        end
+
+        private
+
+        def context
+          context_proc.call
+        end
+
+        def set_prototype_variable_and_yield(_method)
+          var = [key, _method].join('.')
+          str = context.set_prototype_variable(var, _object.send(_method))
+          yield_to_sprinkles("#{str};")
+        end
+
+        def yield_to_sprinkles(content)
+          context.content_for(:sprinkles) do
+            context.content_tag(:script, content.html_safe)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/angular_sprinkles/decorators.rb

@@ -0,0 +1,6 @@
+module AngularSprinkles
+  module Decorators
+  end
+end
+
+require 'angular_sprinkles/decorators/bind_decorator'

data/lib/angular_sprinkles/engine.rb

@@ -0,0 +1,6 @@
+require 'rails'
+
+module AngularSprinkles
+  class Engine < ::Rails::Engine
+  end
+end