dashing_json 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 42c149cc3c2aa76644d5e8cbf19d56c993792e8b
+  data.tar.gz: cec0c1a4b5702969e8764b31ffbf4b3b50283496
+SHA512:
+  metadata.gz: 5c3c0cb881ccb794b3a9564da98fd0e4cd84baed744612687abe5a15bdef1923bf908038cc27e04a1beed86d12f04944de306d09697f1ada0cf7de5fbfc11a9f
+  data.tar.gz: c4908470aa1a027252b86d8a5c6390a7472a76dc920c683f692fa5a27edc8c7950b1f413bccc2233fb9447c4a7ae1db430a636b5531a6da9f7944ae3fdda8d5c

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 John Otander
+
+MIT License
+
+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,122 @@
+# Dashing JSON
+
+Make your JSON absolutely dashing in your rails HTML views since, sometimes, you need to display a raw blob.
+
+Dashing JSON uses a `dashing-json` data element to store the JSON string, which is then parsed into a `ul` with specific `li` elements and corresponding classes: key, string, boolean, null, and number.
+
+It comes with default styling so your JSON blob is sure to look dashing right out of the box.
+
+### Before
+
+```
+{"data": { "key": null, "can_read": false } }
+```
+
+### After
+
+```json
+{
+  "data": {
+    "key": null,
+    "can_read": false
+  }
+}
+```
+
+Yeah, that's right. Egyptian curly braces (you can change that if you want).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dashing_json'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dashing_json
+
+#### Next, you need to require the `.js.coffee` and `.css.scss` assets:
+
+If you're using sprockets, add the following to your `application.css`:
+
+    *= require dashing_json
+
+If you're using an `application.css.scss` file:
+
+```scss
+@import "dashing_json";
+```
+
+And, include the scripts with the following in your `application.js`
+
+    *= require dashing_json
+
+## Usage
+
+Now, you simply need to instantiate the JSON blob in you controller:
+
+```ruby
+class ModelController < ApplicationController
+
+# ...
+
+  def show
+    @model = Model.find(params[:id])
+    @json_blob = @model.to_json
+  end
+
+# ...
+```
+
+And, then call the `dashing_json` method in your view:
+
+```erb
+<%= # ... %>
+
+<%= dashing_json(@json_blob) %>
+
+<%= # ... %>
+```
+
+That's it, your JSON is now dashing.
+
+## Customization
+
+Overriding the default colors of the syntax highlighting is simple since they're just variables. If you're using scss, and would like to customize the styles, you can add the following before you import the stylesheet in `plugins/_dashing_json.scss`:
+
+```scss
+$dashing-json-key-color:     $your-color;
+$dashing-json-string-color:  $your-color;
+$dashing-json-number-color:  $your-color;
+$dashing-json-boolean-color: $your-color;
+
+@import "dashing_json";
+```
+
+Be sure to import this file in your `application.css.scss`.
+
+If you aren't using sass, the selectors would be something like: 
+
+```css
+.dashing-json .key,
+.dashing-json .null,
+.dashing-json .string,
+.dashing-json .boolean,
+.dashing-json .number {
+  /* custom styling here */
+}
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/assets/javascripts/dashing_json.js.coffee

@@ -0,0 +1,31 @@
+# Let's make the json extra pretty.
+#
+# Adapted from Pumbaa80's answer on:
+# http://stackoverflow.com/questions/4810841/json-pretty-print-using-javascript
+
+$ ->
+  json.syntaxHighlight()
+  
+  
+json =
+  syntaxHighlight: ->
+    for jsonElem in $('.dashing-json-raw')
+      do (jsonElem) ->
+        jsonData = $(jsonElem).attr('data-dashing-json')
+        if(typeof jsonData != 'string') 
+          jsonData = JSON.stringify(jsonData, undefined, 2)
+        jsonData = jsonData.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;')
+        $('.dashing-json-parsed').append(json.doSyntaxHighlighting(jsonData))
+  
+  doSyntaxHighlighting: (jsonData) ->
+    jsonData.replace /("(\\u[a-zA-Z0-9]{4}|\\[^u]|[^\\"])*"(\s*:)?|\b(true|false|null)\b|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?)/g, (match) -> 
+      if(/^"/.test(match))
+        cls = if /:$/.test(match) then 'key' else 'string'
+      else if(/true|false/.test(match))
+        cls = 'boolean'
+      else if (/null/.test(match))
+        cls = 'null'
+      else if (/[0-9]+/.test(match))
+        cls = 'number'
+
+      return '<li class="' + cls + '">' + match + '</li>'

data/app/assets/stylesheets/dashing_json.css.scss

@@ -0,0 +1,15 @@
+$dashing-json-key-color: #999;
+$dashing-json-string-color: #666;
+$dashing-json-number-color: #222;
+$dashing-json-boolean-color: #444;
+
+.dashing-json .key,
+.dashing-json .null,
+.dashing-json .string,
+.dashing-json .boolean,
+.dashing-json .number { display: inline; }
+
+.dashing-json .key     { color: $dashing-json-key-color;     }
+.dashing-json .string  { color: $dashing-json-string-color;  }
+.dashing-json .number  { color: $dashing-json-number-color;  }
+.dashing-json .boolean { color: $dashing-json-boolean-color; }

data/dashing_json.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dashing_json/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dashing_json"
+  spec.version       = DashingJson::VERSION
+  spec.authors       = ["John Otander"]
+  spec.email         = ["johnotander@gmail.com"]
+  spec.description   = %q{Make your JSON absolutely dashing in your rails HTML views.}
+  spec.summary       = %q{Make your JSON absolutely dashing in your rails HTML views.}
+  spec.homepage      = "https://github.com/johnotander/dashing_json"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/dashing_json.rb

@@ -0,0 +1,11 @@
+require 'dashing_json/version'
+require 'dashing_json/engine'
+require 'dashing_json/view_helpers'
+
+module DashingJson
+  include ViewHelpers
+end
+
+defined?(Rails::Railtie) ?
+  require('dashing_json/railtie') :
+  raise('dashing_json requires Rails::Railtie')

data/lib/dashing_json/engine.rb

@@ -0,0 +1,6 @@
+module DashingJson
+  if defined?(::Rails::Engine)
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/dashing_json/railtie.rb

@@ -0,0 +1,9 @@
+require 'dashing_json'
+
+module DashingJson
+  class Railtie < Rails::Railtie
+    initializer 'dashing_json' do |app|
+      ActionView::Base.send :include, DashingJson
+    end
+  end
+end

data/lib/dashing_json/version.rb

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

data/lib/dashing_json/view_helpers.rb

@@ -0,0 +1,21 @@
+module DashingJson
+  module ViewHelpers
+    
+    def dashing_json(data)
+      generate_html(data).html_safe
+    end
+
+    def generate_html(data)
+      data = data.to_json unless data and data.is_a?(String)
+      
+      <<-HTML
+        <div class='dashing-json'>
+          <pre>
+            <ul class='dashing-json-parsed'></ul>
+            <div class='dashing-json-raw' data-dashing-json='#{ JSON.pretty_generate(JSON.parse(data)) }'></div>
+          </pre>
+        </div>
+      HTML
+    end
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: dashing_json
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Otander
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: Make your JSON absolutely dashing in your rails HTML views.
+email:
+- johnotander@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/javascripts/dashing_json.js.coffee
+- app/assets/stylesheets/dashing_json.css.scss
+- dashing_json.gemspec
+- lib/dashing_json.rb
+- lib/dashing_json/engine.rb
+- lib/dashing_json/railtie.rb
+- lib/dashing_json/version.rb
+- lib/dashing_json/view_helpers.rb
+homepage: https://github.com/johnotander/dashing_json
+licenses:
+- MIT
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Make your JSON absolutely dashing in your rails HTML views.
+test_files: []