has_star 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3f5d83577d1ffe4cd717342600041cbb3492b0a0
+  data.tar.gz: fabb3e6e71531f36e5fb7bf94aa8d31f0b21ec7a
+SHA512:
+  metadata.gz: 9b5b26d4446f1a8f7bd3f7ab977c0987636e8d944521f01c0a4c8c9a5d746ffb19adffcef49b8786e3aa0c11177cfe60fbd676fb78a7e6ce6c24a3b8d953f1fa
+  data.tar.gz: 86d6c94d3174c8ae129253ce216eed68ceaf5b5fd068c21682c5bb2c6e3a3f445a3b0d78462430d19f60e302b2b10d27ef31ca967cdabf8b1f0314ef462f82df

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Marcos Neves
+
+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/Rakefile

@@ -0,0 +1,34 @@
+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    = 'HasStar'
+  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

data/app/assets/stylesheets/has_star.css

@@ -0,0 +1,26 @@
+@keyframes toogle-star-spin {
+  0% {
+    -webkit-transform: rotate(0deg);
+    transform: rotate(0deg);
+  }
+  100% {
+    -webkit-transform: rotate(359deg);
+    transform: rotate(359deg);
+  }
+}
+
+.has-star {
+  text-decoration: none;
+  color: Orange;
+  transition: all 0.5s;
+}
+
+.has-star:hover {
+  color: DarkOrange;
+}
+
+.has-star:focus {
+  /*animation: toogle-star-spin 1s infinite ease-in-out;*/
+  opacity: 0.5;
+  color: silver;
+}

data/lib/generators/has_star/USAGE

@@ -0,0 +1,8 @@
+Description:
+  1) Migrate `star` field to table
+  2) Insert `has_star` into model
+  3) Insert `has_star` into controller
+  4) Insert `has_star` into routes
+
+Examples:
+  `rails generate has_star movie`

data/lib/generators/has_star/has_star_generator.rb

@@ -0,0 +1,73 @@
+require 'rails/generators/active_record'
+
+class HasStarGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+  include Rails::Generators::Migration
+
+  def create_migration_file
+    # using Rails::Generators::Migration
+    migration_template 'add_star_to.rb.erb', "db/migrate/add_star_to_#{table_name}.rb"
+  end
+
+  def add_has_star_to_model
+    with_file model_file do |file|
+      insert_into_file file, "\n  has_star", after: 'ActiveRecord::Base'
+    end
+  end
+
+  def add_has_star_to_controller
+    with_file controller_file do |file|
+      insert_into_file file, render_template('controller.erb'), after: /class .+$/
+    end
+  end
+
+  def add_has_star_to_routes
+    with_file 'config/routes.rb' do |file|
+      insert_into_file file, "\n  has_star :#{table_name}", after: 'Rails.application.routes.draw do'
+    end
+  end
+
+  def add_has_star_to_css
+    with_file 'app/assets/stylesheets/application.css' do |file|
+      insert_into_file file, " *= require has_star\n", before: ' *= require_tree'
+    end
+  end
+
+  private
+
+  def render_template(name)
+    template = File.expand_path(find_in_source_paths(name))
+    ERB.new(::File.binread(template), nil, "-", "@output_buffer").result(instance_eval("binding"))
+  end
+
+  def with_file(file, &block)
+    return say("File not found: #{file}", :magenta) unless File.exist? Rails.root.join(file)
+    yield file
+  end
+
+  # convert the name from commandline like:
+  # rails g has_star posts
+  # rails g has_star post
+  # rails g has_star Post
+  # to posts
+  def table_name
+    name.tableize
+  end
+
+  def model_class
+    table_name.classify
+  end
+
+  def model_file
+    "app/models/#{table_name.singularize}.rb"
+  end
+
+  def controller_file
+    "app/controllers/#{table_name}_controller.rb"
+  end
+
+  # required by Rails::Generators::Migration
+  def self.next_migration_number(dirname)
+    ActiveRecord::Generators::Base.next_migration_number(dirname)
+  end
+end

data/lib/generators/has_star/templates/add_star_to.rb.erb

@@ -0,0 +1,5 @@
+class AddStarTo<%= table_name.camelize %> < ActiveRecord::Migration
+  def change
+    add_column :<%= table_name %>, :star, :boolean, default: false
+  end
+end

data/lib/generators/has_star/templates/controller.erb

@@ -0,0 +1,16 @@
+
+  has_star
+
+  def resource
+    @<%= table_name.singularize %> = <%= model_class %>.find params[:id]
+  end
+
+  def starred
+    @<%= table_name %> = <%= model_class %>.starred
+    render :index
+  end
+
+  def unstarred
+    @<%= table_name %> = <%= model_class %>.unstarred
+    render :index
+  end

data/lib/has_star/builder.rb

@@ -0,0 +1,44 @@
+module HasStar
+  # take logic out of has_star helper method
+  # makes it easy to override
+  class Builder < ::Struct.new(:model, :h)
+    # content based on model.star status, already html safed
+    def content
+      (model.star? ? starred : unstarred).html_safe
+    end
+
+    # html code for solid star, could be &hearts;
+    def starred
+      '&#x2605;'
+    end
+
+    # html code for empty star
+    def unstarred
+      '&#9734;'
+    end
+
+    # /posts/980190962/toggle_star
+    def url
+      [:toggle_star, model]
+    end
+
+    # has_star_post_980190962
+    def id
+      h.dom_id(model, :has_star)
+    end
+
+    # override to add extra classes
+    def classes
+      'has-star'
+    end
+
+    def render
+      h.link_to content, url, method: :patch, remote: true, id: id, class: classes
+      # data: {disable_with: '<span class="toggle-star-loading">&#8635;</span>'},
+    end
+
+    def to_s
+      render
+    end
+  end
+end

data/lib/has_star/controller.rb

@@ -0,0 +1,23 @@
+module HasStar
+  module Controller
+    def toggle_star
+      has_star_resource.toggle_star!
+      render_star
+    end
+
+    protected
+
+    def render_star
+      render inline: <<-EOF
+        <% builder = HasStar::Builder.new(@has_star_resource, self) %>
+        $('#<%= builder.id %>')
+        .html('<%= builder.content %>')
+        .blur()
+      EOF
+    end
+
+    def has_star_resource
+      @has_star_resource ||= send self.class.has_star_resource_method
+    end
+  end
+end

data/lib/has_star/helper.rb

@@ -0,0 +1,7 @@
+module HasStar
+  module Helper
+    def has_star(model)
+      Builder.new(model, self)
+    end
+  end
+end

data/lib/has_star/model.rb

@@ -0,0 +1,16 @@
+module HasStar
+  module Model
+    extend ActiveSupport::Concern
+
+    def toggle_star!
+      self.class.record_timestamps = false
+      toggle! :star
+      self.class.record_timestamps = true
+    end
+
+    included do
+      scope :starred,   -> { where star: true  }
+      scope :unstarred, -> { where star: false }
+    end
+  end
+end

data/lib/has_star/route.rb

@@ -0,0 +1,14 @@
+module HasStar
+  module Route
+    def has_star(controller)
+      patch "/#{controller}/:id/toggle_star" => "#{controller}#toggle_star",
+            as: "toggle_star_#{controller.to_s.singularize}"
+
+      get "/#{controller}/starred" => "#{controller}#starred",
+          as: "starred_#{controller}"
+
+      get "/#{controller}/unstarred" => "#{controller}#unstarred",
+          as: "unstarred_#{controller}"
+    end
+  end
+end

data/lib/has_star/version.rb

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

data/lib/has_star.rb

@@ -0,0 +1,32 @@
+require 'has_star/controller'
+require 'has_star/builder'
+require 'has_star/helper'
+require 'has_star/model'
+require 'has_star/route'
+
+module HasStar
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+
+  module ActiveRecord
+    def has_star
+      include Model
+    end
+  end
+
+  module ActionController
+    attr_accessor :has_star_resource_method
+
+    def has_star(resource_method = :resource)
+      self.has_star_resource_method = resource_method
+      include Controller
+    end
+  end
+end
+
+ActiveRecord::Base.send              :extend,  HasStar::ActiveRecord
+ActionController::Base.send          :extend,  HasStar::ActionController
+ActionView::Base.send                :include, HasStar::Helper
+ActionDispatch::Routing::Mapper.send :include, HasStar::Route

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,14 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,16 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require has_star
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/controllers/posts_controller.rb

@@ -0,0 +1,23 @@
+class PostsController < ApplicationController
+  has_star
+
+  def resource
+    @post = Post.find params[:id]
+  end
+
+  def starred
+    @posts = Post.starred
+    render :index
+  end
+
+  def unstarred
+    @posts = Post.unstarred
+    render :index
+  end
+
+  before_action -> { sleep 0.5 }, only: :toggle_star
+
+  def index
+    @posts = Post.all
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/post.rb

@@ -0,0 +1,3 @@
+class Post < ActiveRecord::Base
+  has_star
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/app/views/posts/index.html.erb

@@ -0,0 +1,14 @@
+<%= link_to 'all', posts_path %>
+ |
+<%= link_to 'starred', starred_posts_path %>
+ |
+<%= link_to 'unstarred', unstarred_posts_path %>
+
+<ul>
+  <% @posts.each do |post| %>
+  <li>
+    <%= has_star post %> |
+    <%= post.title %>
+  </li>
+  <% end %>
+</ul>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+begin
+  load File.expand_path("../spring", __FILE__)
+rescue LoadError
+end
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/test/dummy/bin/spring

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+# This file loads spring without using Bundler, in order to be fast.
+# It gets overwritten when you run the `spring binstub` command.
+
+unless defined?(Spring)
+  require "rubygems"
+  require "bundler"
+
+  if match = Bundler.default_lockfile.read.match(/^GEM$.*?^    (?:  )*spring \((.*?)\)$.*?^$/m)
+    Gem.paths = { "GEM_PATH" => [Bundler.bundle_path.to_s, *Gem.path].uniq }
+    gem "spring", match[1]
+    require "spring/binstub"
+  end
+end

data/test/dummy/config/application.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "has_star"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,41 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end