friendly_id-method_scopes 0.1.5

data/friendly_id-method_scopes.gemspec

@@ -0,0 +1,154 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: friendly_id-method_scopes 0.1.5 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "friendly_id-method_scopes"
+  s.version = "0.1.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Karen Lundgren"]
+  s.date = "2015-06-22"
+  s.description = "FriendlyId Extension to allow method scopes, in addition to column and relationship scopes."
+  s.email = "karen.e.lundgren@gmail.com"
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".rspec",
+    ".ruby-gemspec",
+    ".ruby-version",
+    ".travis.yml",
+    "Gemfile",
+    "MIT-LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "coverage/.last_run.json",
+    "coverage/.resultset.json",
+    "coverage/.resultset.json.lock",
+    "friendly_id-method_scopes.gemspec",
+    "lib/friendly_id/method_scopes.rb",
+    "lib/friendly_id/method_scopes/version.rb",
+    "spec/controllers/authors_controller_spec.rb",
+    "spec/controllers/books_controller_spec.rb",
+    "spec/dummy/Rakefile",
+    "spec/dummy/app/assets/javascripts/application.js",
+    "spec/dummy/app/assets/stylesheets/application.css",
+    "spec/dummy/app/assets/stylesheets/scaffold.css",
+    "spec/dummy/app/controllers/application_controller.rb",
+    "spec/dummy/app/controllers/authors_controller.rb",
+    "spec/dummy/app/controllers/books_controller.rb",
+    "spec/dummy/app/models/.keep",
+    "spec/dummy/app/models/author.rb",
+    "spec/dummy/app/models/book.rb",
+    "spec/dummy/app/models/role.rb",
+    "spec/dummy/app/views/authors/index.html.haml",
+    "spec/dummy/app/views/authors/show.html.haml",
+    "spec/dummy/app/views/books/index.html.haml",
+    "spec/dummy/app/views/books/show.html.haml",
+    "spec/dummy/app/views/layouts/application.html.haml",
+    "spec/dummy/bin/bundle",
+    "spec/dummy/bin/rails",
+    "spec/dummy/bin/rake",
+    "spec/dummy/bin/setup",
+    "spec/dummy/config.ru",
+    "spec/dummy/config/application.rb",
+    "spec/dummy/config/boot.rb",
+    "spec/dummy/config/database.yml",
+    "spec/dummy/config/environment.rb",
+    "spec/dummy/config/environments/development.rb",
+    "spec/dummy/config/environments/production.rb",
+    "spec/dummy/config/environments/test.rb",
+    "spec/dummy/config/initializers/assets.rb",
+    "spec/dummy/config/initializers/backtrace_silencers.rb",
+    "spec/dummy/config/initializers/cookies_serializer.rb",
+    "spec/dummy/config/initializers/filter_parameter_logging.rb",
+    "spec/dummy/config/initializers/inflections.rb",
+    "spec/dummy/config/initializers/mime_types.rb",
+    "spec/dummy/config/initializers/rolify.rb",
+    "spec/dummy/config/initializers/session_store.rb",
+    "spec/dummy/config/initializers/wrap_parameters.rb",
+    "spec/dummy/config/locales/en.yml",
+    "spec/dummy/config/routes.rb",
+    "spec/dummy/config/secrets.yml",
+    "spec/dummy/db/migrate/20150621221655_create_books.rb",
+    "spec/dummy/db/migrate/20150621221732_create_authors.rb",
+    "spec/dummy/db/migrate/20150622182214_rolify_create_roles.rb",
+    "spec/dummy/db/schema.rb",
+    "spec/dummy/db/seeds.rb",
+    "spec/dummy/db/seeds/authors.seeds.rb",
+    "spec/dummy/db/seeds/books.seeds.rb",
+    "spec/dummy/lib/assets/.keep",
+    "spec/dummy/log/.keep",
+    "spec/dummy/public/404.html",
+    "spec/dummy/public/422.html",
+    "spec/dummy/public/500.html",
+    "spec/dummy/public/favicon.ico",
+    "spec/factories/author.rb",
+    "spec/factories/book.rb",
+    "spec/models/author_spec.rb",
+    "spec/models/book_spec.rb",
+    "spec/rails_helper.rb",
+    "spec/routing/authors_routing_spec.rb",
+    "spec/routing/books_routing_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/authors.rb",
+    "spec/support/books_with_authors.rb"
+  ]
+  s.homepage = "http://www.gemvein.com/museum/cases/friendly_id-method_scopes"
+  s.rubygems_version = "2.4.5"
+  s.summary = "FriendlyId Extension to allow method scopes."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, ["~> 4"])
+      s.add_runtime_dependency(%q<friendly_id>, ["~> 5"])
+      s.add_runtime_dependency(%q<jeweler>, ["~> 2"])
+      s.add_runtime_dependency(%q<coveralls>, ["~> 0.8"])
+      s.add_development_dependency(%q<sqlite3>, ["~> 1"])
+      s.add_development_dependency(%q<rspec-rails>, ["~> 3.3"])
+      s.add_development_dependency(%q<shoulda-matchers>, ["~> 2.8"])
+      s.add_development_dependency(%q<rolify>, ["~> 4"])
+      s.add_development_dependency(%q<seedbank>, ["~> 0.3"])
+      s.add_development_dependency(%q<factory_girl_rails>, ["~> 4.5"])
+      s.add_development_dependency(%q<faker>, ["~> 1.4"])
+      s.add_development_dependency(%q<haml>, ["~> 4"])
+      s.add_development_dependency(%q<database_cleaner>, ["~> 1.4"])
+    else
+      s.add_dependency(%q<rails>, ["~> 4"])
+      s.add_dependency(%q<friendly_id>, ["~> 5"])
+      s.add_dependency(%q<jeweler>, ["~> 2"])
+      s.add_dependency(%q<coveralls>, ["~> 0.8"])
+      s.add_dependency(%q<sqlite3>, ["~> 1"])
+      s.add_dependency(%q<rspec-rails>, ["~> 3.3"])
+      s.add_dependency(%q<shoulda-matchers>, ["~> 2.8"])
+      s.add_dependency(%q<rolify>, ["~> 4"])
+      s.add_dependency(%q<seedbank>, ["~> 0.3"])
+      s.add_dependency(%q<factory_girl_rails>, ["~> 4.5"])
+      s.add_dependency(%q<faker>, ["~> 1.4"])
+      s.add_dependency(%q<haml>, ["~> 4"])
+      s.add_dependency(%q<database_cleaner>, ["~> 1.4"])
+    end
+  else
+    s.add_dependency(%q<rails>, ["~> 4"])
+    s.add_dependency(%q<friendly_id>, ["~> 5"])
+    s.add_dependency(%q<jeweler>, ["~> 2"])
+    s.add_dependency(%q<coveralls>, ["~> 0.8"])
+    s.add_dependency(%q<sqlite3>, ["~> 1"])
+    s.add_dependency(%q<rspec-rails>, ["~> 3.3"])
+    s.add_dependency(%q<shoulda-matchers>, ["~> 2.8"])
+    s.add_dependency(%q<rolify>, ["~> 4"])
+    s.add_dependency(%q<seedbank>, ["~> 0.3"])
+    s.add_dependency(%q<factory_girl_rails>, ["~> 4.5"])
+    s.add_dependency(%q<faker>, ["~> 1.4"])
+    s.add_dependency(%q<haml>, ["~> 4"])
+    s.add_dependency(%q<database_cleaner>, ["~> 1.4"])
+  end
+end
+

data/lib/friendly_id/method_scopes.rb

@@ -0,0 +1,69 @@
+module FriendlyId
+  module MethodScopes
+
+    # FriendlyId::Config.use will invoke this method when present, to allow
+    # loading dependent modules prior to overriding them when necessary.
+    def self.setup(model_class)
+      model_class.friendly_id_config.use :slugged
+    end
+
+    # Sets up behavior and configuration options for FriendlyId::MethodScopes's method_scopes slugs
+    # feature.
+    def self.included(model_class)
+      model_class.class_eval do
+        friendly_id_config.class.send :include, Configuration
+      end
+    end
+
+    # # This doesn't work yet, but will be used to hook up to the history module
+    # def serialized_scope
+    #   friendly_id_config.scope_method_columns.sort.map { |column, method| "#{column}:#{send(method)}" }.join(",")
+    # end
+
+    def scope_for_slug_generator
+      relation = self.class.unscoped.friendly
+      friendly_id_config.scope_method_columns.each do |column, method|
+        relation = relation.where(column => send(method))
+      end
+      primary_key_name = self.class.primary_key
+      relation.where(self.class.arel_table[primary_key_name].not_eq(send(primary_key_name)))
+    end
+    private :scope_for_slug_generator
+
+    def slug_generator
+      friendly_id_config.slug_generator_class.new(scope_for_slug_generator)
+    end
+    private :slug_generator
+
+    module Configuration
+      attr_accessor :scope_methods
+
+      def scope_method_columns
+        [@scope_methods].flatten.map { |s|
+          column = (method_foreign_key(s) or method_so_id(s) or s).to_s
+          my_method = (method_foreign_key(s) or method_so_method(s) or s).to_s
+          [column, my_method]
+        }
+      end
+
+      private
+
+      def method_so_id(scope)
+        if model_class.method_defined? scope
+          :id
+        end
+      end
+
+      def method_so_method(scope)
+        if model_class.method_defined? scope
+          scope
+        end
+      end
+
+      def method_foreign_key(scope)
+        reflection = model_class.reflections[scope] || model_class.reflections[scope.to_s]
+        reflection.try(:foreign_key)
+      end
+    end
+  end
+end

data/lib/friendly_id/method_scopes/version.rb

@@ -0,0 +1,9 @@
+module FriendlyId
+  module MethodScopes
+    VERSION = File.read(File.expand_path('../../../../VERSION', __FILE__))
+
+    def self.version_string
+      "FriendlyId::MethodScopes version #{FriendlyId::MethodScopes::VERSION}"
+    end
+  end
+end

data/spec/controllers/authors_controller_spec.rb

@@ -0,0 +1,20 @@
+require 'rails_helper'
+
+RSpec.describe AuthorsController do
+  include_context 'books with authors'
+
+  describe "GET #index" do
+    it "assigns all authors as @authors" do
+      get :index
+      expect(assigns(:authors)).to eq([first_author, second_author])
+    end
+  end
+
+  describe "GET #show" do
+    it "assigns the requested author as @author" do
+      get :show, {:id => first_author.to_param}
+      expect(assigns(:author)).to eq(first_author)
+    end
+  end
+
+end

data/spec/controllers/books_controller_spec.rb

@@ -0,0 +1,20 @@
+require 'rails_helper'
+
+RSpec.describe BooksController do
+  include_context 'books with authors'
+
+  describe "GET #index" do
+    it "assigns author's books as @books" do
+      get :index, author_id: first_author.to_param
+      expect(assigns(:books)).to eq([book_a, book_b_first])
+    end
+  end
+
+  describe "GET #show" do
+    it "assigns the requested book as @book" do
+      get :show, author_id: first_author.to_param, id: book_b_first.to_param
+      expect(assigns(:book)).to eq(book_b_first)
+    end
+  end
+
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,9 @@
+# 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
+
+require 'seedbank'
+Seedbank.load_tasks if defined?(Seedbank)

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

@@ -0,0 +1,13 @@
+// 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_tree .

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

@@ -0,0 +1,15 @@
+/*
+ * 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_tree .
+ *= require_self
+ */

data/spec/dummy/app/assets/stylesheets/scaffold.css

@@ -0,0 +1 @@
+/* I hate this file. */

data/spec/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/spec/dummy/app/controllers/authors_controller.rb

@@ -0,0 +1,18 @@
+class AuthorsController < ApplicationController
+  before_action :set_author, only: :show
+
+  # GET /authors
+  def index
+    @authors = Author.all
+  end
+
+  # GET /authors/author-slug
+  def show
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_author
+      @author = Author.friendly.find(params[:id])
+    end
+end

data/spec/dummy/app/controllers/books_controller.rb

@@ -0,0 +1,23 @@
+class BooksController < ApplicationController
+  before_action :set_author
+  before_action :set_book, only: :show
+
+  # GET /authors/author-slug/books
+  def index
+    @books = @author.books
+  end
+
+  # GET /authors/author-slug/books/book-slug
+  def show
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_book
+      @book = @author.books.friendly.find(params[:id])
+    end
+
+    def set_author
+      @author = Author.friendly.find(params[:author_id])
+    end
+end

data/spec/dummy/app/models/author.rb

@@ -0,0 +1,12 @@
+class Author < ActiveRecord::Base
+  # Rolify Gem
+  rolify
+
+  # FriendlyId Gem
+  extend FriendlyId
+  friendly_id :full_name, use: :slugged
+
+  def books
+    Book.with_role(:author, self)
+  end
+end

data/spec/dummy/app/models/book.rb

@@ -0,0 +1,16 @@
+class Book < ActiveRecord::Base
+  # Rolify Gem
+  resourcify
+
+  # FriendlyId Gem
+  extend FriendlyId
+  friendly_id :title, use: [:slugged, :method_scopes], scope_methods: :also_written_by
+
+  def authors
+    Author.with_role(:author, self)
+  end
+
+  def also_written_by
+    Book.where(id: authors.collect { |o| o.books.ids }.flatten )
+  end
+end

data/spec/dummy/app/models/role.rb

@@ -0,0 +1,10 @@
+class Role < ActiveRecord::Base
+  has_and_belongs_to_many :authors, :join_table => :authors_roles
+  belongs_to :resource, :polymorphic => true
+
+  validates :resource_type,
+            :inclusion => { :in => Rolify.resource_types },
+            :allow_nil => true
+
+  scopify
+end

data/spec/dummy/app/views/authors/index.html.haml

@@ -0,0 +1,5 @@
+%p#notice= notice
+%h1 Listing Authors
+%ul
+  - @authors.each do |author|
+    %li= link_to author.full_name, author

data/spec/dummy/app/views/authors/show.html.haml

@@ -0,0 +1,5 @@
+%p#notice= notice
+%h1
+  = @author.full_name
+%p
+  = link_to 'Books', author_books_path(@author)

data/spec/dummy/app/views/books/index.html.haml

@@ -0,0 +1,5 @@
+%p#notice= notice
+%h1= "Listing Books by #{@author.full_name}"
+%ul
+  - @books.each do |book|
+    %li= link_to book.title, [@author, book]