per_page_loader 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ce6a8984aa6ffb37fece5f1c97ad79291bfff9805c372f1b798ed3cb0e80a444
+  data.tar.gz: 42d4ace048e76903e1d169d0afd4dbc0f78c7e4d76e77fb62a968a16f69683ee
+SHA512:
+  metadata.gz: 6792f643781d9593f66417b2151d0007b5622987901ef03f00d1429e6fade928ccd3f8dc4098dcf1fefb481e5262c5f5a8e8aab9925a5def3213ea281558771a
+  data.tar.gz: 49972155e03bc7d02838c83b9d6ec06def8c274505520ef83d86aaab33729f00813611fe2692ca21121993731f82574146bccf41a7e6cd8805a1bba3e5e6d2d7

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at KDRaypole01@indianatech.net. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in per_page_loader.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,150 @@
+PATH
+  remote: .
+  specs:
+    per_page_loader (0.1.0)
+      rails (>= 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.4.2)
+      actionpack (= 5.2.4.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.4.2)
+      actionpack (= 5.2.4.2)
+      actionview (= 5.2.4.2)
+      activejob (= 5.2.4.2)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.4.2)
+      actionview (= 5.2.4.2)
+      activesupport (= 5.2.4.2)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.4.2)
+      activesupport (= 5.2.4.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.4.2)
+      activesupport (= 5.2.4.2)
+      globalid (>= 0.3.6)
+    activemodel (5.2.4.2)
+      activesupport (= 5.2.4.2)
+    activerecord (5.2.4.2)
+      activemodel (= 5.2.4.2)
+      activesupport (= 5.2.4.2)
+      arel (>= 9.0)
+    activestorage (5.2.4.2)
+      actionpack (= 5.2.4.2)
+      activerecord (= 5.2.4.2)
+      marcel (~> 0.3.1)
+    activesupport (5.2.4.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    builder (3.2.4)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.6)
+    crass (1.0.6)
+    diff-lcs (1.3)
+    erubi (1.9.0)
+    generator_spec (0.9.4)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    loofah (2.4.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.4)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.0)
+    nio4r (2.5.2)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rack (2.2.2)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.4.2)
+      actioncable (= 5.2.4.2)
+      actionmailer (= 5.2.4.2)
+      actionpack (= 5.2.4.2)
+      actionview (= 5.2.4.2)
+      activejob (= 5.2.4.2)
+      activemodel (= 5.2.4.2)
+      activerecord (= 5.2.4.2)
+      activestorage (= 5.2.4.2)
+      activesupport (= 5.2.4.2)
+      bundler (>= 1.3.0)
+      railties (= 5.2.4.2)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (5.2.4.2)
+      actionpack (= 5.2.4.2)
+      activesupport (= 5.2.4.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rake (12.3.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    sprockets (4.0.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  generator_spec
+  per_page_loader!
+  pry
+  rake
+  rspec
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Kobe
+
+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,71 @@
+# PerPageLoader
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'per_page_loader'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install per_page_loader
+
+## Usage
+PerPageLoader lets you attach page specific coffeescript to your rails application using jquery to load the specific coffee class and method that are needed for your controller action.
+
+### Setup
+After including the gem it is as simple as wrapping your application html in the `per_page_container` helper method.
+
+```haml
+%body
+  = per_page_container do
+    = yield
+```
+
+Adding this helper to the layouts will give PerPageLoader access to loading in javascript for every page.
+
+### Generators
+The PerPageLoader has a specific format of coffeescript controller that it looks for and we have built generators to help build these files for you.
+
+`rails generate per_page_loader:controller User` will generate...
+
+```coffeescript
+# app/assets/javascripts/application/controllers/users_controller.coffee
+class UsersController
+window.UsersController = UsersController
+```
+
+Auto generating the actions is as easy as passing in the names of the actions.
+
+`rails generate per_page_loader:controller User index show` will generate...
+
+```coffeescript
+# app/assets/javascripts/application/controllers/users_controller.coffee
+class UsersController
+
+  indexAction: ->
+
+  showAction: ->
+
+window.UsersController = UsersController
+```
+
+If it is necessary to change the location that the file is generated the `--dir=dir_name` flag can be used.
+
+`rails generate per_page_loader:controller User --dir=admin` will generate...
+
+```coffeescript
+# app/assets/javascripts/admin/controllers/users_controller.coffee
+class UsersController
+window.UsersController = UsersController
+```
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/views/per_page_loader/_container.html.erb

@@ -0,0 +1,2 @@
+<div class="js-per-page-container" data-controller="<%= javascript_controller %>" data-action="<%= javascript_action %>">
+</div>

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "per_page_loader"
+
+# 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/per_page_loader/base_generator.rb

@@ -0,0 +1,11 @@
+require 'rails/generators/named_base'
+
+module PerPageLoader
+  module Generators
+    class BaseGenerator < Rails::Generators::NamedBase
+      def self.source_root
+        File.expand_path('../templates', __FILE__)
+      end
+    end
+  end
+end

data/lib/generators/per_page_loader/component_generator.rb

@@ -0,0 +1,14 @@
+require 'generators/per_page_loader/base_generator'
+
+module PerPageLoader
+  module Generators
+    class ComponentGenerator < BaseGenerator
+      argument :actions, type: :array, default: [], banner: "Array of actions to be added to the component"
+      class_option :dir, type: :string, default: "application", desc: "The directory where the file should go"
+
+      def create_coffee_component_file
+        template 'component.erb', File.join("app/assets/javascripts/#{options[:dir]}/components", "#{file_name}_component.coffee")
+      end
+    end
+  end
+end

data/lib/generators/per_page_loader/controller_generator.rb

@@ -0,0 +1,14 @@
+require 'generators/per_page_loader/base_generator'
+
+module PerPageLoader
+  module Generators
+    class ControllerGenerator < BaseGenerator
+      argument :actions, type: :array, default: [], banner: "Array of actions to be added to the controller"
+      class_option :dir, type: :string, default: "application", desc: "The directory where the file should go"
+
+      def create_coffee_controller_file
+        template 'controller.erb', File.join("app/assets/javascripts/#{options[:dir]}/controllers", "#{table_name}_controller.coffee")
+      end
+    end
+  end
+end

data/lib/generators/per_page_loader/templates/component.erb

@@ -0,0 +1,5 @@
+class <%= class_name %>Component
+<% actions.each do |action| %>
+  @<%= action %>: ->
+<% end %>
+window.<%= class_name %>Component = <%= class_name %>Component

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

@@ -0,0 +1,5 @@
+class <%= class_name.pluralize %>Controller
+<% actions.each do |action| %>
+  <%= action %>Action: ->
+<% end %>
+window.<%= class_name.pluralize %>Controller = <%= class_name.pluralize %>Controller

data/lib/per_page_loader.rb

@@ -0,0 +1,5 @@
+require 'rails'
+require 'per_page_loader/engine'
+require 'per_page_loader/version'
+require 'per_page_loader/per_page_helper'
+require 'per_page_loader/container'

data/lib/per_page_loader/container.rb

@@ -0,0 +1,21 @@
+module PerPageLoader
+  class Container
+    attr_accessor :view_context
+
+    def initialize(view_context)
+      @view_context = view_context
+    end
+
+    def render
+      view_context.render(
+        partial: partial_name
+      )
+    end
+
+    private
+
+    def partial_name
+      self.class.name.underscore
+    end
+  end
+end

data/lib/per_page_loader/engine.rb

@@ -0,0 +1,7 @@
+module PerPageLoader
+  class Engine < Rails::Engine
+    initializer "per_page_loader.per_page_helper" do |app|
+      ActionView::Base.send :include, PerPageLoader::PerPageHelper
+    end
+  end
+end

data/lib/per_page_loader/per_page_helper.rb

@@ -0,0 +1,23 @@
+module PerPageLoader
+  module PerPageHelper
+    def per_page_container
+      PerPageLoader::Container.new(self).render
+    end
+
+    def javascript_controller
+      controller_path.gsub('/', '_').camelize
+    end
+
+    def javascript_action
+      controller.action_name.camelize(:lower) + 'Action'
+    end
+
+    def json_partial(partial, options = {})
+      options.reverse_merge! locals: nil
+      passed_options = {partial: partial, locals: options[:locals], formats: options[:formats]}
+      passed_options.merge!(collection: options[:collection]) if options[:collection]
+
+      render(passed_options).to_json.html_safe
+    end
+  end
+end

data/lib/per_page_loader/version.rb

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

data/per_page_loader.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/per_page_loader/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "per_page_loader"
+  spec.version       = PerPageLoader::VERSION
+  spec.authors       = ["Kobe"]
+  spec.email         = ["Kobe@rouxbe.com"]
+
+  spec.summary       = 'Per page loader for coffeescript on rails applications'
+  spec.description   = 'Per page loader for coffeescript on rails applications'
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # 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 "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "generator_spec"
+  spec.add_dependency 'rails', '>= 3.0'
+end

data/vendor/assets/javascripts/per_page_loader.js

@@ -0,0 +1,31 @@
+(function() {
+  var PerPageLoader;
+
+  PerPageLoader = (function() {
+    function PerPageLoader() {}
+
+    PerPageLoader.initialize = function() {
+      var action, container, controller, controller_instance, error;
+      container = document.getElementsByClassName('js-per-page-container')[0];
+      controller = container.dataset.controller;
+      action = container.dataset.action;
+      try {
+        controller_instance = new window[controller + "Controller"]();
+        return controller_instance[action]();
+      } catch (_error) {
+        error = _error;
+        return console.log(error);
+      }
+    };
+
+    return PerPageLoader;
+
+  })();
+
+  window.PerPageLoader = PerPageLoader;
+
+  document.addEventListener('DOMContentLoaded', function() {
+    return PerPageLoader.initialize();
+  });
+
+}).call(this);

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: per_page_loader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kobe
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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
+  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: pry
+  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: generator_spec
+  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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Per page loader for coffeescript on rails applications
+email:
+- Kobe@rouxbe.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/views/per_page_loader/_container.html.erb
+- bin/console
+- bin/setup
+- lib/generators/per_page_loader/base_generator.rb
+- lib/generators/per_page_loader/component_generator.rb
+- lib/generators/per_page_loader/controller_generator.rb
+- lib/generators/per_page_loader/templates/component.erb
+- lib/generators/per_page_loader/templates/controller.erb
+- lib/per_page_loader.rb
+- lib/per_page_loader/container.rb
+- lib/per_page_loader/engine.rb
+- lib/per_page_loader/per_page_helper.rb
+- lib/per_page_loader/version.rb
+- per_page_loader.gemspec
+- vendor/assets/javascripts/per_page_loader.js
+homepage: 
+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.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.9
+signing_key: 
+specification_version: 4
+summary: Per page loader for coffeescript on rails applications
+test_files: []