partially_useful 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4984329239fd5a85108938655401c329977ceb8e
+  data.tar.gz: abd37c9937630d613140a3143ab9cc13bfd14f88
+SHA512:
+  metadata.gz: 4f6f880cc74e312e10e73c38f0695bcab871526f7061be02adfa52c72d1aebe4db82f88c60510b8d3908c84f96bc2864b7cca77d76a675da89db6605e2479415
+  data.tar.gz: f8ec63080e1ff8efc7316665c6a3d6335636b7d8ab3419f214220496f680d0b348823adc1977573ef620679aa54449bccdc17b2e9cef9c59bcb219bf9c92f3e7

data/.gitignore

@@ -0,0 +1,6 @@
+.bundle/
+log/*.log
+*.gem
+pkg/
+test/dummy/log/*.log
+test/dummy/tmp/

data/.travis.yml

@@ -0,0 +1,3 @@
+script: "bundle exec rake"
+rvm:
+  - 2.1.0

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    partially_useful (0.0.1)
+      railties (>= 4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (4.1.1)
+      actionview (= 4.1.1)
+      activesupport (= 4.1.1)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.1)
+      activesupport (= 4.1.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activesupport (4.1.1)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    builder (3.2.2)
+    erubis (2.7.0)
+    i18n (0.6.9)
+    json (1.8.1)
+    minitest (5.3.3)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    railties (4.1.1)
+      actionpack (= 4.1.1)
+      activesupport (= 4.1.1)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.3.1)
+    thor (0.19.1)
+    thread_safe (0.3.3)
+    tzinfo (1.1.0)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  partially_useful!
+  rake

data/README.md

@@ -0,0 +1,47 @@
+# PartiallyUseful
+
+When looking at a rendered html page, it's often hard to tell where the code of a partial lives inside the views directory.
+
+Surrounds rendered partials with html-comments in order to simplify the process of finding the proper file.
+
+```html
+<!-- start rendering 'some_partial' with locals '[:all, :assigned, :locals]'-->
+<div class="hello">
+    <div class="world">
+      [...]
+    </div>
+</div>
+<!-- end rendering 'some_partial' with locals '[:all, :assigned, :locals]'-->
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'partially_useful', group: 'development'
+```
+
+## Usage
+
+The plugin is enabled by default, buy you can disable it in your rails configuration:
+
+```ruby
+# config/environments/development.rb
+config.partially_useful = false
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/partially_useful/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## License
+
+"THE (extended) BEER-WARE LICENSE" (Revision 42.0815): [phoet](mailto:ps@nofail.de) contributed to this project.
+
+As long as you retain this notice you can do whatever you want with this stuff.
+If we meet some day, and you think this stuff is worth it, you can buy me some beers in return.

data/Rakefile

@@ -0,0 +1,29 @@
+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    = 'PartiallyUseful'
+  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/lib/partially_useful.rb

@@ -0,0 +1,3 @@
+require "partially_useful/version"
+require "partially_useful/partial_renderer"
+require "partially_useful/engine"

data/lib/partially_useful/engine.rb

@@ -0,0 +1,11 @@
+module PartiallyUseful
+  class Engine < Rails::Engine
+    config.partially_useful = true
+
+    initializer :partially_useful do |app|
+      if app.config.partially_useful
+        ActionView::PartialRenderer.prepend PartiallyUseful::PartialRenderer
+      end
+    end
+  end
+end

data/lib/partially_useful/partial_renderer.rb

@@ -0,0 +1,8 @@
+module PartiallyUseful
+  module PartialRenderer
+    def render(context, options, block)
+      msg = "rendering '#{options[:partial]}' with locals '#{(options[:locals] || {}).keys}'"
+      "<!-- start #{msg}-->\n#{super(context, options, block)}\n<!-- end #{msg}-->\n".html_safe
+    end
+  end
+end

data/lib/partially_useful/version.rb

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

data/partially_useful.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'partially_useful/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "partially_useful"
+  spec.version       = PartiallyUseful::VERSION
+  spec.authors       = ["phoet"]
+  spec.email         = ["phoetmail@googlemail.com"]
+  spec.homepage      = "https://github.com/phoet/partially_useful"
+  spec.license       = "extended beerware license"
+  spec.summary = spec.description = "Helps finding partials in large html pages"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'railties', '~> 4.0'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

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/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

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

@@ -0,0 +1,2 @@
+class WelcomeController < ApplicationController
+end

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

@@ -0,0 +1,3 @@
+<footer>
+  (c)(r) <%= link_to '@phoet', 'http://github/phoet' %>
+</footer>

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

@@ -0,0 +1,3 @@
+<header>
+  <h1>Hellooooo</h1>
+</header>

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

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= render 'header' %>
+
+<%= yield %>
+
+<%= render 'footer' %>
+
+</body>
+</html>

data/test/dummy/app/views/welcome/_welcome.html.erb

@@ -0,0 +1 @@
+<h3><%= message %></h3>

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

@@ -0,0 +1,5 @@
+<h1>Whutup?</h1>
+
+<%= render 'welcome', message: 'döpdöpdöp' %>
+
+<p>lorem ipsum</p>

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,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application

data/test/dummy/config/application.rb

@@ -0,0 +1,13 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'action_controller/railtie'
+require 'action_view/railtie'
+
+Bundler.require(*Rails.groups)
+require "partially_useful"
+
+module Dummy
+  class Application < Rails::Application
+    config.partially_useful = 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/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,7 @@
+Rails.application.configure do
+  config.cache_classes = false
+  config.eager_load = false
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+  config.active_support.deprecation = :log
+end

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

@@ -0,0 +1,9 @@
+Rails.application.configure do
+  config.cache_classes = true
+  config.eager_load = false
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+  config.action_dispatch.show_exceptions = false
+  config.action_controller.allow_forgery_protection = false
+  config.active_support.deprecation = :stderr
+end

data/test/dummy/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += [:password]

data/test/dummy/config/initializers/secret_token.rb

@@ -0,0 +1 @@
+Rails.application.config.secret_key_base  = '_dummy_secret'

data/test/dummy/config/initializers/session_store.rb

@@ -0,0 +1,3 @@
+# Be sure to restart your server when you modify this file.
+
+Rails.application.config.session_store :cookie_store, key: '_dummy_session'

data/test/dummy/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  root 'welcome#index'
+end

data/test/partially_useful_test.rb

@@ -0,0 +1,10 @@
+require 'test_helper'
+
+class PartiallyUsefulTest < ActionController::TestCase
+  tests WelcomeController
+
+  test "should get index" do
+    get :index
+    assert_match "<!-- start rendering 'header' with locals '[]'-->", @response.body
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require "rails/test_help"
+
+Rails.backtrace_cleaner.remove_silencers!

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: partially_useful
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- phoet
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+description: Helps finding partials in large html pages
+email:
+- phoetmail@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/partially_useful.rb
+- lib/partially_useful/engine.rb
+- lib/partially_useful/partial_renderer.rb
+- lib/partially_useful/version.rb
+- partially_useful.gemspec
+- test/dummy/Rakefile
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/welcome_controller.rb
+- test/dummy/app/views/application/_footer.html.erb
+- test/dummy/app/views/application/_header.html.erb
+- test/dummy/app/views/layouts/application.html.erb
+- test/dummy/app/views/welcome/_welcome.html.erb
+- test/dummy/app/views/welcome/index.html.erb
+- test/dummy/bin/bundle
+- test/dummy/bin/rails
+- test/dummy/bin/rake
+- test/dummy/config.ru
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/environment.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/initializers/filter_parameter_logging.rb
+- test/dummy/config/initializers/secret_token.rb
+- test/dummy/config/initializers/session_store.rb
+- test/dummy/config/routes.rb
+- test/dummy/log/.keep
+- test/dummy/public/favicon.ico
+- test/partially_useful_test.rb
+- test/test_helper.rb
+homepage: https://github.com/phoet/partially_useful
+licenses:
+- extended beerware license
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Helps finding partials in large html pages
+test_files:
+- test/dummy/Rakefile
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/welcome_controller.rb
+- test/dummy/app/views/application/_footer.html.erb
+- test/dummy/app/views/application/_header.html.erb
+- test/dummy/app/views/layouts/application.html.erb
+- test/dummy/app/views/welcome/_welcome.html.erb
+- test/dummy/app/views/welcome/index.html.erb
+- test/dummy/bin/bundle
+- test/dummy/bin/rails
+- test/dummy/bin/rake
+- test/dummy/config.ru
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/environment.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/initializers/filter_parameter_logging.rb
+- test/dummy/config/initializers/secret_token.rb
+- test/dummy/config/initializers/session_store.rb
+- test/dummy/config/routes.rb
+- test/dummy/log/.keep
+- test/dummy/public/favicon.ico
+- test/partially_useful_test.rb
+- test/test_helper.rb
+has_rdoc: