starrr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d04658a56b183c0acc7de02a9a0eeb171e63f18ec378c71048c24b4de05570b1
+  data.tar.gz: 1900be95d8ff4da62bc8940f002fd27de885adf672313d7019665bacc44c3298
+SHA512:
+  metadata.gz: e20677bf47a63bc84f151e0344f98a09622653b62fbb6df447356a14607b936bcf462d3cd6ec928be3f694111180a7e4ff17958af383595354b96e18371ad84f
+  data.tar.gz: 763a98f7e1120b1cbce1798d6f90edef67eb12a391090c1d101d2cd47408d86d64d0b26161b34a4d27aef8bfb31b545235ff3e7dc30a067df56b38d61741a84e

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in starrr.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Sikandar Tariq
+
+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,101 @@
+# Starrr
+Simple star/rating input field.
+
+Courtesy: https://github.com/dobtco/starrr
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'starrr'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install starrr
+
+Generate starter code
+
+    $ rails g starrr core_extensions
+
+Import javascript file
+```js
+//= require starrr.js
+```
+
+Import css file
+```sass
+@import "starrr";
+```
+
+## Usage
+
+### Create the stars
+
+```html
+<div class='starrr'></div>
+```
+
+```js
+$('.starrr').starrr()
+```
+
+### With an existing rating
+
+```js
+$('.starrr').starrr({
+  rating: 4
+})
+```
+
+### With more than 5 stars
+
+```js
+$('.starrr').starrr({
+  max: 10
+})
+```
+
+### Read-only
+
+```js
+$('.starrr').starrr({
+  readOnly: true
+})
+```
+
+### Do something with the rating...
+
+```js
+$('.starrr').starrr({
+  change: function(e, value){
+    alert('new rating is ' + value)
+  }
+})
+```
+
+Or if you prefer events:
+
+```js
+$('.starrr').on('starrr:change', function(e, value){
+  alert('new rating is ' + value)
+})
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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/sikandartariq1/starrr.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "starrr"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/starrr_generator.rb

@@ -0,0 +1,8 @@
+class StarrrGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('templates', __dir__)
+
+  def copy_initializer_file
+    copy_file "stars.coffee", "app/assets/javascripts/stars.coffee"
+    copy_file "stars.scss", "app/assets/stylesheets/stars.coffee"
+  end
+end

data/lib/generators/templates/stars.coffee

@@ -0,0 +1,66 @@
+(($, window) ->
+
+  window.Starrr = class Starrr
+    defaults:
+      rating: undefined
+      max: 5
+      readOnly: false
+      emptyClass: 'material-icons star_border'
+      fullClass: 'material-icons star'
+      change: (e, value) ->
+
+    constructor: ($el, options) ->
+      @options = $.extend({}, @defaults, options)
+      @$el = $el
+      @createStars()
+      @syncRating()
+
+      return if @options.readOnly
+
+      @$el.on 'mouseover.starrr', 'a', (e) =>
+        @syncRating(@getStars().index(e.currentTarget) + 1)
+
+      @$el.on 'mouseout.starrr', =>
+        @syncRating()
+
+      @$el.on 'click.starrr', 'a', (e) =>
+        e.preventDefault()
+        @setRating(@getStars().index(e.currentTarget) + 1)
+
+      @$el.on 'starrr:change', @options.change
+
+    getStars: ->
+      @$el.find('a')
+
+    createStars: ->
+      @$el.append("<a href='#' />") for [1..@options.max]
+
+    setRating: (rating) ->
+      rating = undefined if @options.rating == rating
+      @options.rating = rating
+      @syncRating()
+      @$el.trigger('starrr:change', rating)
+
+    getRating: ->
+      @options.rating
+
+    syncRating: (rating) ->
+      rating ||= @options.rating
+      $stars = @getStars()
+      for i in [1..@options.max]
+        $stars.
+          eq(i - 1).
+          removeClass(if rating >= i then @options.emptyClass else @options.fullClass).
+          addClass(if rating >= i then @options.fullClass else @options.emptyClass)
+
+  # Define the plugin
+  $.fn.extend starrr: (option, args...) ->
+    @each ->
+      data = $(@).data('starrr')
+
+      if !data
+        $(@).data 'starrr', (data = new Starrr($(@), option))
+      if typeof option == 'string'
+        data[option].apply(data, args)
+
+) window.jQuery, window

data/lib/generators/templates/stars.scss

@@ -0,0 +1,13 @@
+$starrrColor: #FFD119 !default;
+
+.starrr {
+  display: inline-block;
+
+  a {
+    font-size: 16px;
+    padding: 0 1px;
+    cursor: pointer;
+    color: $starrrColor;
+    text-decoration: none;
+  }
+}

data/lib/starrr/version.rb

@@ -0,0 +1,3 @@
+module Starrr
+  VERSION = "0.1.0"
+end

data/lib/starrr.rb

@@ -0,0 +1,5 @@
+require "starrr/version"
+
+module Starrr
+  class Engine < ::Rails::Engine; end
+end

data/starrr.gemspec

@@ -0,0 +1,37 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "starrr/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "starrr"
+  spec.version       = Starrr::VERSION
+  spec.authors       = ["Sikandar Tariq"]
+  spec.email         = ["sikandar.tariq@thedevden.co"]
+
+  spec.summary       = "1-5 (or 1-n) star rating in < 75 lines of code."
+  spec.description   = "rails front-end library for star/rating input field"
+  spec.homepage      = "https://github.com/sikandartariq1/starrr"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/vendor/assets/javascripts/starrr.js

@@ -0,0 +1,98 @@
+var slice = [].slice;
+
+(function($, window) {
+  var Starrr;
+  window.Starrr = Starrr = (function() {
+    Starrr.prototype.defaults = {
+      rating: void 0,
+      max: 5,
+      readOnly: false,
+      emptyClass: 'fa fa-star-o',
+      fullClass: 'fa fa-star',
+      change: function(e, value) {}
+    };
+
+    function Starrr($el, options) {
+      this.options = $.extend({}, this.defaults, options);
+      this.$el = $el;
+      this.createStars();
+      this.syncRating();
+      if (this.options.readOnly) {
+        return;
+      }
+      this.$el.on('mouseover.starrr', 'a', (function(_this) {
+        return function(e) {
+          return _this.syncRating(_this.getStars().index(e.currentTarget) + 1);
+        };
+      })(this));
+      this.$el.on('mouseout.starrr', (function(_this) {
+        return function() {
+          return _this.syncRating();
+        };
+      })(this));
+      this.$el.on('click.starrr', 'a', (function(_this) {
+        return function(e) {
+          e.preventDefault();
+          return _this.setRating(_this.getStars().index(e.currentTarget) + 1);
+        };
+      })(this));
+      this.$el.on('starrr:change', this.options.change);
+    }
+
+    Starrr.prototype.getStars = function() {
+      return this.$el.find('a');
+    };
+
+    Starrr.prototype.createStars = function() {
+      var j, ref, results;
+      results = [];
+      for (j = 1, ref = this.options.max; 1 <= ref ? j <= ref : j >= ref; 1 <= ref ? j++ : j--) {
+        results.push(this.$el.append("<a href='#' />"));
+      }
+      return results;
+    };
+
+    Starrr.prototype.setRating = function(rating) {
+      if (this.options.rating === rating) {
+        rating = void 0;
+      }
+      this.options.rating = rating;
+      this.syncRating();
+      return this.$el.trigger('starrr:change', rating);
+    };
+
+    Starrr.prototype.getRating = function() {
+      return this.options.rating;
+    };
+
+    Starrr.prototype.syncRating = function(rating) {
+      var $stars, i, j, ref, results;
+      rating || (rating = this.options.rating);
+      $stars = this.getStars();
+      results = [];
+      for (i = j = 1, ref = this.options.max; 1 <= ref ? j <= ref : j >= ref; i = 1 <= ref ? ++j : --j) {
+        results.push($stars.eq(i - 1).removeClass(rating >= i ? this.options.emptyClass : this.options.fullClass).addClass(rating >= i ? this.options.fullClass : this.options.emptyClass));
+      }
+      return results;
+    };
+
+    return Starrr;
+
+  })();
+  return $.fn.extend({
+    starrr: function() {
+      var args, option;
+      option = arguments[0], args = 2 <= arguments.length ? slice.call(arguments, 1) : [];
+      return this.each(function() {
+        var data;
+        data = $(this).data('starrr');
+        if (!data) {
+          $(this).data('starrr', (data = new Starrr($(this), option)));
+        }
+        if (typeof option === 'string') {
+          return data[option].apply(data, args);
+        }
+      });
+    }
+  });
+})(window.jQuery, window);

data/vendor/assets/stylesheets/starrr.css

@@ -0,0 +1,8 @@
+.starrr {
+  display: inline-block; }
+  .starrr a {
+    font-size: 16px;
+    padding: 0 1px;
+    cursor: pointer;
+    color: #FFD119;
+    text-decoration: none; }

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: starrr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sikandar Tariq
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rails front-end library for star/rating input field
+email:
+- sikandar.tariq@thedevden.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/starrr_generator.rb
+- lib/generators/templates/stars.coffee
+- lib/generators/templates/stars.scss
+- lib/starrr.rb
+- lib/starrr/version.rb
+- starrr.gemspec
+- vendor/assets/javascripts/starrr.js
+- vendor/assets/stylesheets/starrr.css
+homepage: https://github.com/sikandartariq1/starrr
+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.7.6
+signing_key: 
+specification_version: 4
+summary: 1-5 (or 1-n) star rating in < 75 lines of code.
+test_files: []