simple-navigation 3.10.1 → 3.11.0

data/CHANGELOG

@@ -1,3 +1,7 @@
+*3.11.0
+
+* Added Json renderer. Thanks to Alberto Avila.
+
 *3.10.1
 
 * Padrino adapter now returns "html_safe"d content_tag

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source "https://rubygems.org"
 
 gem 'activesupport', '>= 2.3.2'
 
@@ -10,6 +10,7 @@ end
 
 group :development do
   gem 'rspec', '>= 2.0.1'
+  gem 'json_spec', '~> 1.1.1'
   gem 'rake'
   gem 'rdoc'
   gem 'jeweler'

data/VERSION

@@ -1 +1 @@
-3.10.1
+3.11.0

data/lib/simple_navigation.rb

@@ -25,7 +25,8 @@ module SimpleNavigation
     :list         => SimpleNavigation::Renderer::List,
     :links        => SimpleNavigation::Renderer::Links,
     :breadcrumbs  => SimpleNavigation::Renderer::Breadcrumbs,
-    :text         => SimpleNavigation::Renderer::Text
+    :text         => SimpleNavigation::Renderer::Text,
+    :json         => SimpleNavigation::Renderer::Json
   }
   
   class << self

data/lib/simple_navigation/rendering.rb

@@ -7,5 +7,6 @@ module SimpleNavigation
     autoload :Links, 'simple_navigation/rendering/renderer/links'
     autoload :Breadcrumbs, 'simple_navigation/rendering/renderer/breadcrumbs'
     autoload :Text, 'simple_navigation/rendering/renderer/text'
+    autoload :Json, 'simple_navigation/rendering/renderer/json'
   end
 end

data/lib/simple_navigation/rendering/renderer/json.rb

@@ -0,0 +1,29 @@
+module SimpleNavigation
+  module Renderer
+    
+    # Renders the navigation items as a object tree serialized as a json string, can also output raw ruby Hashes
+    class Json < SimpleNavigation::Renderer::Base
+      
+      def render(item_container)
+        results = hash_render(item_container)
+        results = results.to_json unless options[:as_hash]
+        results
+      end
+
+      private
+
+      def hash_render(item_container)
+        return nil if item_container.nil?
+        item_container.items.map do |item|
+          item_hash = { 
+            :name => item.name, 
+            :url => item.url, 
+            :selected => item.selected?,
+            :items => hash_render(item.sub_navigation)
+          }
+        end        
+      end
+
+    end
+  end
+end

data/spec/lib/simple_navigation/rendering/renderer/json_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe SimpleNavigation::Renderer::Json do
+
+  describe 'render' do
+
+    def render(current_nav=nil, options={})
+      primary_navigation = primary_container
+      select_item(current_nav)
+      setup_renderer_for SimpleNavigation::Renderer::Json, :rails, options
+      @renderer.render(primary_navigation)
+    end
+
+    def prerendered_menu
+      '[{"name":"users","url":"first_url","selected":false,"items":null},{"name":"invoices","url":"second_url","selected":true,"items":[{"name":"subnav1","url":"subnav1_url","selected":false,"items":null},{"name":"subnav2","url":"subnav2_url","selected":false,"items":null}]},{"name":"accounts","url":"third_url","selected":false,"items":null},{"name":"miscellany","url":null,"selected":false,"items":null}]'
+    end
+
+    context 'regarding result' do
+
+      it "should return a string" do
+        render(:invoices).class.should == String
+      end
+
+      it "should render the selected page" do
+        json = parse_json(render(:invoices))
+        found = json.any? do |item| 
+          item["name"] == "invoices" and item["selected"]
+        end
+        found.should == true
+      end
+
+    end
+
+    context 'regarding hash result' do
+      it "should return a hash" do
+        render(:invoices, :as_hash => true).class.should == Array
+      end
+
+      it "should render the selected page" do
+        found = render(:invoices, :as_hash => true).any? do |item|
+          item[:name] == "invoices" and item[:selected]
+        end
+        found.should == true
+      end
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 ENV["RAILS_ENV"] = "test"
 require 'rubygems'
 require 'rspec'
+require 'json_spec'
 require 'action_controller'
 
 module Rails
@@ -28,7 +29,7 @@ RSpec.configure do |config|
   # config.mock_with :flexmock
   # config.mock_with :rr
   config.mock_with :rspec
-
+  config.include JsonSpec::Helpers
 end
 
 # spec helper methods

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple-navigation
 version: !ruby/object:Gem::Version
-  version: 3.10.1
+  version: 3.11.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-10 00:00:00.000000000 Z
+date: 2013-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -44,6 +44,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: json_spec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -130,6 +146,7 @@ files:
 - lib/simple_navigation/rendering/helpers.rb
 - lib/simple_navigation/rendering/renderer/base.rb
 - lib/simple_navigation/rendering/renderer/breadcrumbs.rb
+- lib/simple_navigation/rendering/renderer/json.rb
 - lib/simple_navigation/rendering/renderer/links.rb
 - lib/simple_navigation/rendering/renderer/list.rb
 - lib/simple_navigation/rendering/renderer/text.rb
@@ -146,6 +163,7 @@ files:
 - spec/lib/simple_navigation/rendering/helpers_spec.rb
 - spec/lib/simple_navigation/rendering/renderer/base_spec.rb
 - spec/lib/simple_navigation/rendering/renderer/breadcrumbs_spec.rb
+- spec/lib/simple_navigation/rendering/renderer/json_spec.rb
 - spec/lib/simple_navigation/rendering/renderer/links_spec.rb
 - spec/lib/simple_navigation/rendering/renderer/list_spec.rb
 - spec/lib/simple_navigation/rendering/renderer/text_spec.rb