active_path-path_hints 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 36933136f01edeaa30ec85a9aa7b0cb229d0ede4
+  data.tar.gz: b90b0deb6b9059c03cd26227d20c7c276a815c4c
+SHA512:
+  metadata.gz: 4595a284a6515c113211b4312169b54f2ea05be011cea823fbb6199f3ed236aba0d295e84162872e5ef103f7f4fbd97063b53078167fed07c67949d26b91eb0e
+  data.tar.gz: 02e6272651e62e401f2053783d5b5be41143c00c4cc3122e59adba37c91deebe5d22e97f8b8d75fe5a8618ef58382c3bbd52f06cff71453963c1e890f6956d53

data/.gitignore

@@ -0,0 +1 @@
+.idea

data/README.md

@@ -0,0 +1,45 @@
+# ActivePath Path Hints: 
+
+Path hints for your Rails 5 partials.
+
+## Installation 
+
+Add to your Gemfile:
+
+```ruby
+gem 'active_path-path_hints'
+```
+
+Add the initializer `config/initializers/active_path.rb` and enable `ActivePath`:
+
+```ruby
+
+ActivePath.configure do |config|
+
+  config.enabled = true
+
+end
+
+```
+
+**Path hints:** (use in development only)
+
+
+```ruby
+
+config.path_hints = true
+
+```  
+
+HTML comments are added before and after each partial. Here is sample output:
+
+```html
+<!-- start pages/content -->
+<p>page content</p>
+<!-- end pages/content -->
+<!-- start example/test -->
+<p>example content</p>
+<!-- end example/test -->
+
+```
+Feel free to [submit issues](https://github.com/active-path/path-hints/issues) or [help make it better](https://github.com/active-path/path-hints/pulls). 

data/Rakefile

@@ -0,0 +1,15 @@
+#!/usr/bin/env rake
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'active_path/path_hints/version'
+
+desc "Release version #{ActivePath::PathHints::VERSION} of the gem"
+task :release do
+
+  system "git tag -a v#{ActivePath::PathHints::VERSION} -m 'Tagging #{ActivePath::PathHints::VERSION}'"
+  system 'git push --tags'
+
+  system "gem build active_path-path_hints.gemspec"
+  system "gem push active_path-path_hints-#{ActivePath::PathHints::VERSION}.gem"
+  system "rm active_path-path_hints-#{ActivePath::PathHints::VERSION}.gem"
+end

data/active_path-path_hints.gemspec

@@ -0,0 +1,17 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'active_path/path_hints/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'active_path-path_hints'
+  s.version     = ActivePath::PathHints::VERSION
+  s.date        = '2018-04-28'
+  s.summary     = "ActivePath Path Hints"
+  s.description = "Path hints for your Rails 5 partials"
+  s.authors     = ["Ryan Tulino"]
+  s.email       = 'rtulino@gmail.com'
+  s.files       = `git ls-files`.split("\n")
+  s.homepage    = 'http://rubygems.org/gems/active_path-path_hints'
+  s.required_ruby_version = '>= 2.2.0'
+  s.add_dependency 'rails', '~> 5'
+  s.add_dependency 'active_path', '~> 0.1.0'
+end

data/lib/active_path/path_hints.rb

@@ -0,0 +1 @@
+require 'active_path/path_hints/engine'

data/lib/active_path/path_hints/engine.rb

@@ -0,0 +1,14 @@
+require 'active_path/path_hints/subscriber'
+module ActivePath
+  module PathHints
+    class Engine < Rails::Engine
+      isolate_namespace ActivePath::PathHints
+
+      config.after_initialize do
+        if ActivePath.config.path_hints
+          ActiveSupport::Notifications.subscribe(:render_partial, Subscriber.new)
+        end
+      end
+    end
+  end
+end

data/lib/active_path/path_hints/subscriber.rb

@@ -0,0 +1,23 @@
+require 'active_path/subscribers/subscriber'
+module ActivePath
+  module PathHints
+    class Subscriber < Subscribers::Subscriber
+      def perform
+        buffer.prepend("<!-- start #{partial}#{with_local_variables.to_s} --!>".html_safe)
+        buffer.concat("<!-- end #{partial} --!>".html_safe)
+      end
+
+      private
+
+      def with_local_variables
+        if options.is_a?(Hash)
+          variables = options[:locals].map do |k,v|
+            count = (" (#{v.count})" if v.is_a?(Array)).to_s
+            "#{k} => #{v.class}#{count}"
+          end
+          "\nwith local variables: #{JSON.pretty_generate(variables)}"
+        end
+      end
+    end
+  end
+end

data/lib/active_path/path_hints/version.rb

@@ -0,0 +1,5 @@
+module ActivePath
+  module PathHints
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: active_path-path_hints
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan Tulino
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: active_path
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: Path hints for your Rails 5 partials
+email: rtulino@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- README.md
+- Rakefile
+- active_path-path_hints.gemspec
+- lib/active_path/path_hints.rb
+- lib/active_path/path_hints/engine.rb
+- lib/active_path/path_hints/subscriber.rb
+- lib/active_path/path_hints/version.rb
+homepage: http://rubygems.org/gems/active_path-path_hints
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: ActivePath Path Hints
+test_files: []