star_rating 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f1e03be6c8538957ebb0375b8849a6fd5f882908
+  data.tar.gz: 9e2021c4626fbbef9d5c0ad2f428b281ee23e537
+SHA512:
+  metadata.gz: cb41217ed77faac2a4a70329502057b5098994f86ee8b141dc15a2c4aa54c1c003de6b864543fd0a8f82b11ee1ab07ccf776ab2b5ddaeaf0b42b3b8c112efa7b
+  data.tar.gz: 0e1a16e0733bf23f8dfdb9e3499f882361303678ba6bef70f34838ac31ff06dac97fada7df89bdae8feab719a9248663a550b2eab34beaeea60b5e19b822621a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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,82 @@
+# star_rating gem
+[![Build Status](https://travis-ci.org/johnnylaw/star_rating.png?branch=master)](https://travis-ci.org/johnnylaw/star_rating)
+[![Code Climate](https://codeclimate.com/github/johnnylaw/star_rating.png)](https://codeclimate.com/github/johnnylaw/star_rating)
+
+The star_rating gem allows for the easy integration of a star rating widget into a Rails app running Ruby 2.0 or higher.  The star rating form input as well as the star rating display helper rely entirely on Sass (no JavaScript) to create a **highly** configurable arrangement of any number of stars of any size and appearance.  The default number of stars is of course five.
+
+### Installing star_rating
+
+Install manually using
+
+    gem install star_rating
+
+or more canonically place the following in your Gemfile:
+
+    gem 'star_rating'
+
+and run
+
+    bundle
+
+from the Rails root.  Then run
+
+    rails g star_rating:install
+
+to install ````app/assets/stylesheets/star_rating_settings.css.scss````, the file in which you can override any default settings.
+
+NOTE: The generator will NOT explicitly put a ````*= require star_rating_settings```` in your ````application.*ss```` manifest file, so you will need to do that unless you are using a ````*= require_tree .```` statement in your manifest.
+
+## The form helper
+
+The form helper comes in two varieties just like every other Rails form helper:
+
+    star_rating_input(object_name, method, value: nil, size: nil, html: {})
+
+and
+
+    star_rating_input(method, size: nil, html: {})
+
+the latter being used as part of a form builder, e.g.
+
+    <%= form_for @opinion do |f| %>
+      <%= f.star_rating_input :rating %>
+      ...
+      <%= f.submit 'Rate' %>
+    <% end %>
+
+- The ````value```` option is the value of the currently selected star if the form is for an already existing object. This option is neither necessary nor available on the form builder method.
+- The ````size```` option represents the height of the row of stars (in pixels).  You can configure a default in  star_rating_settings.css.scss.
+- The ````html```` option is for attributes of the &lt;span&gt; tag that contains the form inputs. If a class is given, it will be added to the .star-rating class necessary for proper rendering.
+
+## The view helper
+
+This is for rendering already existing ratings or possibly an average rating for an item.
+
+    star_rating(value = 0, size: nil, rating_html: {}, container_html: {})
+
+- ````value```` is the value of the rating to be rendered, e.g. 3.3 as shown above
+- The ````size```` option is as with the form helper.
+- The ````rating_html```` and the ````container_html```` options are for adding HTML attributes to either of the two containers that make up the output, which essentially looks like (in the example of a value of 3.3 on a 5-point scale):
+
+    ````<span class="star-rating"><span style="width: 66.7%"></span></span>````
+
+A possible use of the ````rating_html```` option would be as follows if you wanted to bind the rating to an AngularJS model:
+
+    star_rating(3.3, rating_html: { 'ng-model' => 'rating' })
+
+speaking of which, my limited knowledge of AngularJS, EmberJS and other JS frameworks prevented me from making the form helpers more configurable, so please hit me with suggestions and/or pull requests if you know how the gem could be better suited for these things.
+
+## Configuration options
+By default there are five stars with values [1, 2, 3, 4, 5], and both the form helper and the view display helper behave accordingly. You can, however, override these settings in a file in ````config/initializers```` with:
+
+    StarRating.configure do |config|
+      config.number_of_stars = 6
+      config.scale = 2
+    end
+
+which would produce 6 stars with values [2, 4, 6, 8, 10, 12].  Additionally the appearance of the stars is highly configurable, utilizing SVG graphics, allowing for changes to spacing, color, outline, gradient (for the "full" stars), and you can even replace the url of the images altogether in the SCSS override file installed by the generator and get something entirely different, such as hearts or babies' faces or baboons' butts.
+
+See the SASS file created by the generator for explicit details about how to configure the different appearance options.
+
+This project is 5-star and uses MIT-LICENSE.
+

data/Rakefile

@@ -0,0 +1,23 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'StarRating'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+

data/config/routes.rb

@@ -0,0 +1,2 @@
+StarRating::Engine.routes.draw do
+end

data/lib/star_rating/engine.rb

@@ -0,0 +1,15 @@
+module StarRating
+  DEFAULT_NUMBER_OF_STARS = 5
+  DEFAULT_SCALE = 1
+
+  class Engine < ::Rails::Engine
+    isolate_namespace StarRating
+    config.number_of_stars = DEFAULT_NUMBER_OF_STARS
+    config.scale = DEFAULT_SCALE
+  end
+
+  def self.configure(&block)
+    yield Engine.config if block
+    Engine.config
+  end
+end

data/lib/star_rating/form_builder_ext.rb

@@ -0,0 +1,7 @@
+module StarRating
+  module FormBuilderExt
+    def star_rating_field(method, size: nil, html: {})
+      @template.star_rating_field(@object_name, method, size: size, html: html, value: @object && @object.send(method))
+    end
+  end
+end

data/lib/star_rating/form_helper_ext.rb

@@ -0,0 +1,21 @@
+module StarRating
+  module FormHelperExt
+    def star_rating_field(object_name, method, size: nil, html: {}, value: nil)
+      css_class = ['star-rating', html.delete(:class)].compact.join(' ')
+      html.merge!(class: css_class)
+      if size
+        width = size * StarRating::Engine.config.number_of_stars
+        html.merge!(style: "width: #{width}px; height: #{size}px")
+      end
+      content_tag(
+        :span,
+        (1..StarRating::Engine.config.number_of_stars).map do |index|
+          input_value = index * StarRating::Engine.config.scale
+          checked = value == input_value
+          radio_button(object_name, method, input_value, class: "star-rating-#{index}", checked: checked) + content_tag(:i)
+        end.join.html_safe,
+        html
+      ).html_safe
+    end
+  end
+end

data/lib/star_rating/generators/install_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators'
+
+module StarRating
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      def add_stylesheet
+        settings_file = File.join(File.dirname(__FILE__), "..", "..", "..", "vendor", "assets", "stylesheets", "star_rating", "_settings.scss")
+        file_name = "app/assets/stylesheets/star_rating_settings.css.scss"
+        create_file file_name, File.read(settings_file)
+        prepend_to_file file_name, "@import 'star_rating/defaults';\n\n"
+        gsub_file file_name, /^[\$]/, '// $'
+        append_to_file file_name, "\n\n@import 'star_rating';"
+      end
+    end
+  end
+end

data/lib/star_rating/helpers.rb

@@ -0,0 +1,22 @@
+module StarRating
+  module Helpers
+    def star_rating(value = 0, size: nil, rating_html: {}, container_html: {})
+      outer_css_class = ['star-rating', container_html.delete(:class)].compact.join(' ')
+      html_attrs = { class: outer_css_class }
+      if size
+        width = size * StarRating::Engine.config.number_of_stars
+        html_attrs.merge!(style: "width: #{width}px; height: #{size}px")
+      end
+      width_percentage = value * 100/StarRating::Engine.config.number_of_stars/StarRating::Engine.config.scale
+      content_tag(
+        :span,
+        content_tag(
+          :span,
+          '',
+          rating_html.merge(style: "width: #{width_percentage}%")
+        ),
+        html_attrs.merge(container_html)
+      )
+    end
+  end
+end

data/lib/star_rating/sass_functions.rb

@@ -0,0 +1,19 @@
+require 'base64'
+
+module StarRating
+  module SassFunctions
+    def self.included(base)
+      base.module_eval do
+        def encode64(string)
+          assert_type string, :String
+          ::Sass::Script::String.new(Base64.encode64(string.value))
+        end
+        declare :encode64, args: [:string]
+
+        def number_of_stars
+          ::Sass::Script::Number.new(StarRating::Engine.config.number_of_stars)
+        end
+      end
+    end
+  end
+end

data/lib/star_rating/version.rb

@@ -0,0 +1,3 @@
+module StarRating
+  VERSION = "0.0.1"
+end

data/lib/star_rating.rb

@@ -0,0 +1,21 @@
+require "star_rating/engine"
+require 'star_rating/generators/install_generator'
+
+require 'sass'
+
+module StarRating
+  extend ActiveSupport::Autoload
+
+  autoload :FormHelperExt
+  autoload :FormBuilderExt
+  autoload :SassFunctions
+  autoload :Helpers
+end
+
+ActionView::Helpers::FormHelper.send :include, StarRating::FormHelperExt
+ActionView::Base.default_form_builder.send :include, StarRating::FormBuilderExt
+Sass::Script::Functions.send :include, StarRating::SassFunctions
+
+ActiveSupport.on_load(:action_view) do
+  include StarRating::Helpers
+end

data/lib/tasks/star_rating_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :star_rating do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: star_rating
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Lawrence
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: genspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Makes it easy to place star-rating inputs into any web app. Configurable
+  appearance, number and value of stars
+email:
+- johnonrails@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- config/routes.rb
+- lib/star_rating/engine.rb
+- lib/star_rating/form_builder_ext.rb
+- lib/star_rating/form_helper_ext.rb
+- lib/star_rating/generators/install_generator.rb
+- lib/star_rating/helpers.rb
+- lib/star_rating/sass_functions.rb
+- lib/star_rating/version.rb
+- lib/star_rating.rb
+- lib/tasks/star_rating_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/johnnylaw/star_rating.git
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ~>
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: A flexible sass-based star-rating system for Rails.
+test_files: []
+has_rdoc: