lazy_elements 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 40b77d9a4de7925e1012db92cdeada3fd47050b0a115bbcc8a24ca6ea537c928
+  data.tar.gz: 711ba6b39c27e9316eee94db5473de01e2e47b2539d2b023cab0813d0a8e1b09
+SHA512:
+  metadata.gz: 4145a3ba3ef26f37c6161130dde29690e6d7b8f029a4ac09ebffb945d6bbdc4f082321d6e51aee335f3f92f5c76eab3ef947a2d09d3fe7cc735f11de0d24df29
+  data.tar.gz: a935f8e2de815d39b0d72157cb329dd4d1c8ccc5b1ecccbb45a7bc006649a1eb6cb19ffda2420ef9c829cbc7f6e2eb429124b0e6cd67b304016c7f373e359e1c

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in lazy_elements.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    lazy_elements (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  lazy_elements!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.0

data/README.md

@@ -0,0 +1,77 @@
+# LazyElements
+
+LazyElements is a gem that can lazy load html template through api.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lazy_elements'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lazy_elements
+
+Run
+    $ rails g lazy_elements:install
+
+
+Add the following to application.js
+
+```
+//=require lazy_elements
+```
+
+
+## Basic Usage
+
+In our view file write
+
+```
+  = lazy_element(:your_partial_template_name)
+```
+
+And add template to app/view/api/lazy_elements/elements/your_partial_template_name
+
+### Use Attributes
+
+If you want to pass a value for template, you can use hash in the name of attr
+
+
+app/views/posts/show.html.haml
+
+```
+  = lazy_element(:lazy_template, {attr: {id: 1, name: 'hoge'}})
+```
+
+app/view/api/lazy_elements/elements/_lazy_template.html.haml
+```
+.test_template
+ = attr[:id]
+ = attr[:name]
+```
+
+
+
+
+## Configuration
+
+You are available some options
+
+- template_path
+- class_name
+
+config/initializers/lazy_elements.rb
+
+```ruby
+LazyElements.configure do |config|
+  config.template_path = 'your template path'
+  config.class_name    = 'your class name'
+end
+```

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/assets/javascripts/lazy_elements.js.erb

@@ -0,0 +1,19 @@
+(function($) {
+  var ready = function(e) {
+    $('.<%= LazyElements.config.class_name %>').each(function(i, e) {
+      var id   = $(e).data('id');
+      var attr = $(e).data('attr');
+
+      var params_h = {id: id, attr: attr}
+      var params = jQuery.param(params_h)
+      var req_url  = '<%= LazyElements.config.controller_path %>' + '?' + params
+
+      $.get(req_url, function(json) {
+        var html = json['template']
+        $('.<%= LazyElements.config.class_name %>[data-id='+id+']').html(html);
+      });
+    });
+  }
+
+  $(document).ready(ready);
+})(jQuery);

data/app/controller/api/lazy_elements/elements_controller.rb

@@ -0,0 +1,10 @@
+class Api::LazyElements::ElementsController < ApplicationController
+  def show
+    name = params[:id]
+    attr = params[:attr]
+
+    file_path = "#{LazyElements.config.template_path}#{name}"
+    template_str = render_to_string(partial: file_path, locals: {attr: attr})
+    render json: {template: template_str}
+  end
+end

data/bin/console

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

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "lazy_elements/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "lazy_elements"
+  spec.version       = LazyElements::VERSION
+  spec.authors       = ["山野井侑"]
+  spec.email         = ["yuu.yamanoi1222@gmail.com"]
+
+  spec.summary       = %q{lazy load html element}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/yyamanoi1222/lazy_elements"
+
+  if spec.respond_to?(:metadata)
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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 "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/generators/lazy_elements/install/install_generator.rb

@@ -0,0 +1,17 @@
+module LazyElements
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      desc "This generator write a route for lazy_elements api"
+
+      def write_lazy_elements_route
+        lazy_elements_route = "namespace :api do\n"
+        lazy_elements_route << "     namespace :lazy_elements do\n"
+        lazy_elements_route << "      resource :elements"
+        lazy_elements_route << ", only: :show\n"
+        lazy_elements_route << "    end\n"
+        lazy_elements_route << "  end"
+        route lazy_elements_route
+      end
+    end
+  end
+end

data/lib/lazy_elements.rb

@@ -0,0 +1,9 @@
+require "lazy_elements/version"
+require "lazy_elements/config"
+require "lazy_elements/engine"
+require "lazy_elements/view_helpers"
+
+module LazyElements
+end
+
+ActionView::Base.send :include, LazyElements::ViewHelpers

data/lib/lazy_elements/config.rb

@@ -0,0 +1,37 @@
+require 'active_support/configurable'
+
+module LazyElements
+  def self.default_controller_path
+    '/api/lazy_elements/elements'
+  end
+
+  def self.default_template_path
+    'api/lazy_elements/elements/'
+  end
+
+  def self.default_class_name
+    'lazy_element'
+  end
+
+  def self.configure(&block)
+    yield @config ||= LazyElements::Configuration.new
+  end
+
+  def self.config
+    @config
+  end
+
+  class Configuration
+    include ActiveSupport::Configurable
+    config_accessor :controller_path
+    config_accessor :template_path
+    config_accessor :class_name
+  end
+
+  configure do |config|
+    config.controller_path = LazyElements.default_controller_path
+    config.template_path   = LazyElements.default_template_path
+    config.class_name      = LazyElements.default_class_name
+  end
+end
+

data/lib/lazy_elements/engine.rb

@@ -0,0 +1,3 @@
+module LazyElements
+  class Engine < Rails::Engine; end
+end

data/lib/lazy_elements/version.rb

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

data/lib/lazy_elements/view_helpers.rb

@@ -0,0 +1,31 @@
+module LazyElements
+  module ViewHelpers
+    def lazy_element(name, options = {})
+      check_template_file!(name)
+      render_lazy_blank_element(name, options[:attr])
+    end
+
+    def render_lazy_blank_element(name, attr)
+      default_option = {'data-id' => name, 'class' => LazyElements.config.class_name}
+
+      option = default_option
+
+      if attr.is_a?(Hash)
+        option['data-attr'] = attr.to_json
+      end
+
+
+      content_tag(:div, '', option)
+    end
+
+    private
+
+    def check_template_file!(name)
+      path = LazyElements.config.template_path
+
+      unless lookup_context.exists?(name.to_s, path, true)
+        raise ActionView::ActionViewError.new("Template missing #{name.to_s} in #{path}")
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: lazy_elements
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- "山野井侑"
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: lazy load html element
+email:
+- yuu.yamanoi1222@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- app/assets/javascripts/lazy_elements.js.erb
+- app/controller/api/lazy_elements/elements_controller.rb
+- bin/console
+- bin/setup
+- lazy_elements.gemspec
+- lib/generators/lazy_elements/install/install_generator.rb
+- lib/lazy_elements.rb
+- lib/lazy_elements/config.rb
+- lib/lazy_elements/engine.rb
+- lib/lazy_elements/version.rb
+- lib/lazy_elements/view_helpers.rb
+homepage: https://github.com/yyamanoi1222/lazy_elements
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: lazy load html element
+test_files: []