jquery-raty-rails 0.0.1

data/LICENSE.md

@@ -0,0 +1,31 @@
+*jquery-raty-rails* is released under a **BSD license**, adapted from
+<http://opensource.org/licenses/bsd-license.php>
+
+Copyright &copy; 2012 Brian M. Clapper.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the names "clapper.org", nor the names of the project's contributors
+  may be used to endorse or promote products derived from this software
+  without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,60 @@
+# jquery-raty-rails
+
+## Introduction
+
+*jquery-raty-rails* is a Ruby gem that wraps the [jQuery Raty][] plugin,
+allowing its image and Javascript files to be served via the [Rails][]
+[asset pipeline][].
+
+[jQuery Raty][] is a useful "star rating" [jQuery][] plugin.
+
+**This project is not officially associated with the [jQuery Raty][] project.**
+
+## Installation
+
+### Install the gem
+
+*jquery-raty-rails* requires Rails 3, since it depends on the asset pipeline.
+
+To install, add one of the following to your Rails project's `Gemfile`:
+
+    gem 'jquery-raty-rails'                                  # Released version
+    gem 'jquery-raty-rails', github: 'bmc/jquery-raty-rails' # Bleeding edge
+
+Then, install the gem by running `bundle install`.
+
+### Configure the assets
+
+Modify the [Sprockets manifest][] in your `application.js` file to include
+*one* of the following, depending on whether you want to include the compressed
+Javascript or the uncompressed Javascript:
+
+    //= require jquery.raty
+    //= require jquery.raty.min
+
+## Usage
+
+At this point, your Rails application has access to jQuery Raty. See the
+[jQuery Raty][] web site for instructions on how to use the plugin.
+
+## Notes
+
+* The [jQuery Raty][] images are installed so that their assets paths won't
+  conflict with same-named images in the application or in other gems.
+* This [blog post][], by Stephen Ball, was a huge help in figuring out how
+  to create this gem.
+
+## Copyrights, License, etc.
+
+[jQuery Raty][] is copyright © [Washington Botelho][].
+
+*jquery-raty-rails* copyright © 2012 Brian M. Clapper and is released
+under a [BSD license](/bmc/jquery-raty-rails/blob/master/LICENSE.md).
+
+[blog post]: http://rakeroutes.com/blog/write-a-gem-for-the-rails-asset-pipeline/
+[Rails]: http://rubyonrails.org/
+[jQuery]: http://jquery.org/
+[jQuery Raty]: http://www.wbotelhos.com/raty/
+[asset pipeline]: http://guides.rubyonrails.org/asset_pipeline.html
+[Sprockets manifest]: https://github.com/sstephenson/sprockets#the-directive-processor
+[Washington Botelho]: https://github.com/wbotelhos

data/Rakefile

@@ -0,0 +1,212 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'JqueryRatyRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test
+
+# ---------------------------------------------------------------------------
+# Local additions
+# ---------------------------------------------------------------------------
+
+require 'fileutils'
+require 'pathname'
+
+include FileUtils
+
+ROOT         = Pathname(File.dirname(__FILE__))
+DOWNLOAD_DIR = ROOT + "tmp/download"
+ASSETS       = ROOT + 'vendor/assets'
+PACKAGE      = "jquery-raty-rails"
+GEMSPEC      = "#{PACKAGE}.gemspec"
+
+def load_gem
+  eval File.open(GEMSPEC).read
+end
+
+def gem_name
+  gem = load_gem
+  version = gem.version.to_s
+  "#{PACKAGE}-#{version}.gem"
+end
+
+# Tasks
+
+desc "Build the gem"
+task :gem => gem_name
+
+desc "Build the gem"
+file gem_name do
+  require 'rubygems/builder'
+  raise "Gem package not defined" unless defined? Gem
+  spec = eval File.open(GEMSPEC).read
+  Gem::Builder.new(spec).build
+end
+
+desc "Publish the gem"
+task :publish => :gem do
+  sh "gem push #{gem_name}"
+end
+
+desc "Update to the most recently released version of jQuery Raty"
+task :update => [:download_raty, :copy_raty] do
+  rm_rf "tmp"
+end
+
+desc "Download and unpack the latest version of jquery-raty"
+task :download_raty do
+  require 'octokit'
+  require 'time'
+
+  gh = Octokit::Client.new
+  newest_time = 0
+  newest = nil
+  download = gh.downloads('wbotelhos/raty').select do |dl|
+    dl["content_type"] == "application/zip"
+  end.map do |dl|
+    dl["timestamp"] = Time.iso8601 dl["created_at"]
+    dl
+  end.sort do |dl1, dl2|
+    dl1["timestamp"].to_i <=> dl2["timestamp"].to_i
+  end.last
+
+  raise "Can't find suitable download" if download.nil?
+
+  rm_rf DOWNLOAD_DIR
+  mkdir_p DOWNLOAD_DIR
+
+  url = download["html_url"]
+  uri = URI(url)
+  filename = File.basename(uri.path)
+  local_path = DOWNLOAD_DIR + filename
+
+  download(uri, local_path)
+  unzip local_path
+end
+
+desc "Copy the jquery-raty assets in place"
+task :copy_raty do
+  %w[javascripts images/jquery.raty].each do |d|
+    mkdir_p ASSETS + d
+  end
+
+  Dir.glob(DOWNLOAD_DIR + 'img/*') do |f|
+    cp(f, ASSETS + "images/jquery.raty/")
+  end
+
+  js_file = DOWNLOAD_DIR + 'js/jquery.raty.js'
+  puts "Editing and copying #{js_file}"
+  js = File.open(js_file).readlines.map do |line|
+    case line
+    when /^(\s+path\s+:)\s'([^']+)'(.*)$/
+      line = "#{$1}'/assets/jquery.raty/'#{$3}\n"
+    end
+    line.gsub(/\r/, "").gsub(%r{^/\*!}, "/**")
+  end
+
+  full_js = ASSETS + "javascripts/jquery.raty.js"
+  File.open(full_js, "wb") { |f| f.write(js.join('')) }
+
+  min_js = ASSETS + "javascripts/jquery.raty.min.js"
+  minify full_js, min_js
+end
+
+# Download a URL, handling redirects and SSL.
+#
+# Parameters:
+#
+# uri  - URI object
+# dest - destination path
+def download(uri, dest)
+  require 'net/http'
+
+  # Would use open-uri, as shown, but it pukes on the GitHub redirection
+  # from an https URL to a cloud http URL.
+  #
+  #     open(local_path, 'wb') do |file|
+  #       file << open(url).read
+  #     end
+  keep_going = true
+  while keep_going
+    use_ssl = uri.scheme == 'https'
+    Net::HTTP.start(uri.host, uri.port, use_ssl: use_ssl) do |http|
+      request = Net::HTTP::Get.new uri.request_uri
+      puts "Downloading #{uri.to_s}"
+      http.request request do |response|
+        if response.is_a? Net::HTTPSuccess
+          File.open(dest, 'wb') do |f|
+            response.read_body do |chunk|
+              f.write chunk
+            end
+          end
+          keep_going = false
+
+        elsif (response.code[0] == '3') && response['location']
+          # Redirect.
+          puts "(Redirected to #{response['location']}"
+          uri = URI(response['location'])
+        else
+          raise "Download failed: #{response.code} #{response.message}"
+        end
+      end
+    end
+  end
+end
+
+def unzip(path)
+  require 'zip/zip'
+
+  puts "Unpacking #{path}"
+  Zip::ZipFile.open(path) do |zip_file|
+    zip_file.each do |entry|
+      dest = File.join(DOWNLOAD_DIR, entry.name)
+      mkdir_p File.dirname(dest), verbose: false
+      zip_file.extract(entry, dest)
+    end
+  end
+end
+
+# Minify JS. Currently expects Google Closure to be installed.
+def minify(input_file, output_file)
+  #require 'uglifier'
+  require 'tempfile'
+
+  puts "Minifying #{input_file} to #{output_file}."
+  Tempfile.open('jquery-raty') do |temp|
+    sh 'closure', input_file.to_s, temp.path
+    temp.rewind
+    File.open(output_file, 'wb') do |out|
+      out.puts "/* Minified by Google Closure */"
+      out.write(temp.read)
+    end
+  end
+end

data/lib/jquery-raty-rails.rb

@@ -0,0 +1,4 @@
+require 'jquery-raty-rails/engine'
+
+module JqueryRatyRails
+end

data/lib/jquery-raty-rails/engine.rb

@@ -0,0 +1,7 @@
+module JqueryRatyRails
+  class Engine < ::Rails::Engine
+    initializer 'jquery-raty-rails.load-jquery-raty-rails' do |app|
+      app.middleware.use ::ActionDispatch::Static, "#{root}/vendor"
+    end
+  end
+end

data/lib/jquery-raty-rails/version.rb

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

data/lib/tasks/jquery-raty-rails_tasks.rake

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

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.