backbone-chooser-rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e5747456fd47f6847c485230f5aba35a37edcb11
+  data.tar.gz: ac389af439b640eec0a9cf856be7a0114f242a37
+SHA512:
+  metadata.gz: 89f37e1bb8cf8f9a360df97019c6866534b7b037c70503e3f56ebf73f397f51ec1f7c3e7b6eb1e89b06acb2f7f9e3e37c58246b637d13e3c811c6ea13bf82e98
+  data.tar.gz: 186fa0f6a0057d307a78afc9ae4e02626335ea92672353d2e8c61bc9cfbe629f5be943a798d3ca4a0f691d52bc234ab03b77d51dabf132ba4aea28d1c0b43d22

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Yevhen V.
+
+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,50 @@
+# Backbone.Chooser-Rails
+
+backbone-chooser-rails wraps the [Backbone.Chooser](https://github.com/brian-mann/Backbone.Chooser)
+plugin in a rails engine for simple use with the asset pipeline provided by
+Rails 3.1 and higher. The gem includes the development (non-minified) source
+for ease of exploration. The asset pipeline will minify in production.
+
+Backbone.Chooser plugin allows to easily track your selected, aka chosen models
+and collection.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'backbone-chooser-rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install backbone-chooser-rails
+
+## Usage
+
+Add the following directive to your Javascript manifest file (application.js):
+
+    //= require backbone-chooser
+
+For the further details, please refer to the [Backbone.Chooser](https://github.com/brian-mann/Backbone.Chooser)
+documentation.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yevgenko/backbone-chooser-rails.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/lib/backbone/chooser/rails.rb

@@ -0,0 +1,10 @@
+require "backbone/chooser/rails/version"
+
+module Backbone
+  module Chooser
+    module Rails
+      class Engine < ::Rails::Engine
+      end
+    end
+  end
+end

data/lib/backbone/chooser/rails/version.rb

@@ -0,0 +1,7 @@
+module Backbone
+  module Chooser
+    module Rails
+      VERSION = "1.0.0"
+    end
+  end
+end

data/vendor/assets/javascripts/backbone-chooser.coffee

@@ -0,0 +1,178 @@
+do (Backbone) ->
+
+  class Backbone.Chooser
+    constructor: (model) ->
+      @model = model
+      @model._chooser = @
+
+      @model[method] = _.bind(@[method], @) for method in @_publicMethods()
+
+      @chosen = false
+      @model.set chosen: false
+
+    _publicMethods: -> ["choose", "unchoose", "toggleChoose", "isChosen"]
+
+    isChosen: ->
+      !!@chosen
+
+    choose: (options = {}) ->
+      return if @isChosen()
+
+      @chosen = true
+      @model.set chosen: true, options
+      @model.trigger "model:chosen", @model unless options.silent is true
+      @model.collection?.choose?(@model, options)
+
+    unchoose: (options = {}) ->
+      return if !@isChosen()
+
+      @chosen = false
+      @model.set chosen: false, options
+      @model.trigger "model:unchosen", @model unless options.silent is true
+      @model.collection?.unchoose?(@model, options)
+
+    toggleChoose: ->
+      if @isChosen() then @unchoose() else @choose()
+
+  class BaseChooser
+    constructor: (collection) ->
+      @collection = collection
+
+      @collection._chooser = @
+      @collection._chooser.chosen = {}
+
+      @collection[method] = _.bind(@[method], @) for method in @_publicMethods()
+
+    _publicMethods: -> ["choose", "unchoose", "getChosen", "getFirstChosen", "chooseById"]
+
+    getChosen: ->
+      _.toArray @chosen
+
+    getFirstChosen: ->
+      @getChosen()[0]
+
+    modelInChosen: (model) ->
+      model.cid in _.keys @chosen
+
+    addModel: (model, options = {}) ->
+      @chosen[model.cid] = model
+      model.choose?(options)
+
+    removeModels: (model = false) ->
+      for model in _.flatten [model or @getChosen()]
+        delete @chosen[model.cid]
+        model.unchoose?()
+
+    triggerEvent: (event = false, options = {}) ->
+      _.defaults options, silent: false
+
+      return if options.silent is true
+
+      event or= @_getEvent()
+      @collection.trigger event, @_eventArg()
+
+    chooseById: (id, options = {}) ->
+      model = @collection.get(id)
+      @choose model, options if model
+
+  class Backbone.SingleChooser extends BaseChooser
+    ## return only the first model as the event argument
+    _eventArg: -> @getFirstChosen()
+
+    choose: (model, options) ->
+      ## return if the model is already chosen
+      return if @modelInChosen(model)
+
+      @removeModels()
+
+      ## add the model to the chosen array
+      @addModel(model)
+
+      ## fire a chosen event
+      @triggerEvent "collection:chose:one", options
+
+    unchoose: (model, options) ->
+      return if !@modelInChosen(model)
+
+      @removeModels(model)
+
+      ## fire a unchose event
+      @triggerEvent "collection:unchose:one", options
+
+  class Backbone.MultiChooser extends BaseChooser
+    constructor: ->
+      super
+      @collection[method] = _.bind(@[method], @) for method in ["chooseAll", "chooseNone", "chooseByIds"]
+
+    ## return all of the chosen models as the event argument
+    _eventArg: -> @getChosen()
+
+    choose: (args...) ->
+      options = if _.chain(args).flatten().last().value() not instanceof Backbone.Model then args.pop() else {}
+
+      eventShouldTrigger = false
+
+      for model in _([args]).flatten()
+        ## break if the model is already chosen
+        break if @modelInChosen(model)
+
+        ## know to trigger a one time event
+        eventShouldTrigger or= true
+
+        ## add the model to the chosen array
+        @addModel(model, options)
+
+      ## fire event
+      @triggerEvent(false, options) if eventShouldTrigger
+
+    unchoose: (args...) ->
+      options = if _.chain(args).flatten().last().value() not instanceof Backbone.Model then args.pop() else {}
+
+      eventShouldTrigger = false
+
+      for model in _([args]).flatten()
+        ## break if the model is already chosen
+        break if !@modelInChosen(model)
+
+        ## know to trigger a one time event
+        eventShouldTrigger or= true
+
+        ## add the model to the chosen array
+        @removeModels(model, options)
+
+      ## fire event
+      @triggerEvent(false, options) if eventShouldTrigger
+
+    chooseAll: (options = {}) ->
+      return if not _.difference(@collection.models, @getChosen()).length
+
+      @addModel(model) for model in @collection.models
+
+      @triggerEvent(false, options)
+
+    chooseNone: (options = {}) ->
+      return if @getChosen().length is 0
+
+      @removeModels()
+
+      @triggerEvent(false, options)
+
+    ## chooses models by an array of ids
+    ## passing chooseNone as options will
+    ## first clear the current chosen
+    chooseByIds: (ids = [], options = {}) ->
+      _.defaults options, chooseNone: true
+
+      @chooseNone options if options.chooseNone
+
+      for id in _([ids]).flatten()
+        @chooseById id, options
+
+    _getEvent: ->
+      if @collection.length is @getChosen().length
+        return "collection:chose:all"
+
+      if @getChosen().length is 0
+        return "collection:chose:none"
+
+      return "collection:chose:some"

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: backbone-chooser-rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Yevhen V.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Backbone.Chooser plugin allow to easily track your selected, aka chosen
+  models and collection.
+email:
+- wik@bdhr.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/backbone/chooser/rails.rb
+- lib/backbone/chooser/rails/version.rb
+- vendor/assets/javascripts/backbone-chooser.coffee
+homepage: https://github.com/yevgenko/backbone-chooser-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Backbone.Chooser plugin ready to play with Rails.
+test_files: []