navtastic 0.0.1

data/spec/navtastic/renderer_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+RSpec.describe Navtastic::Renderer do
+  describe '.render' do
+    subject(:renderer) { described_class.render menu }
+
+    let(:current_url) { '/' }
+    let(:menu) do
+      menu = Navtastic::Menu.new
+      menu.item "Home", '/'
+      menu.current_url = current_url
+      menu
+    end
+
+    it "returns an instance of Navtastic::Renderer" do
+      expect(renderer).to be_a described_class
+    end
+  end
+end

data/spec/navtastic_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+RSpec.describe Navtastic do
+  subject(:define_menu) do
+    described_class.define menu_name do |menu|
+      menu.item 'a', '/'
+    end
+  end
+
+  let(:menu_name) { "test" }
+
+  describe '.define' do
+    context "when a block was given" do
+      it "doesn't raise an error" do
+        expect { define_menu }.not_to raise_error
+      end
+
+      it "stores the menu in the store" do
+        expect { define_menu }.to(change { described_class.all_menus.count })
+      end
+
+      it "converts a string to a symbol in the store" do
+        define_menu
+        expect(described_class.all_menus).to include menu_name.to_sym
+      end
+    end
+
+    context "when no block was given" do
+      subject(:define_menu) { described_class.define :test }
+
+      it "raises an ArgumentError" do
+        expect { define_menu }.to raise_error ArgumentError
+      end
+    end
+  end
+
+  describe '.render' do
+    before { define_menu }
+
+    subject(:renderer) { described_class.render(menu_name, '/') }
+
+    context "when the menu was found" do
+      specify { expect(renderer).to be_a Navtastic::Renderer }
+    end
+
+    context "when the menu was not found" do
+      subject(:renderer) { described_class.render("foo", '/') }
+
+      specify { expect { renderer }.to raise_error KeyError }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,113 @@
+if ENV["COVERAGE"]
+  require 'simplecov'
+  SimpleCov.start
+end
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'bundler/setup'
+Bundler.setup
+
+require 'navtastic'
+require 'pp'
+
+require 'support/navtastic_store'
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  # config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  # config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

data/spec/support/matchers/current_item.rb

@@ -0,0 +1,51 @@
+# Check if the menu has a specific current item
+RSpec::Matchers.define :have_current_item do |item = nil|
+  match do |menu|
+    @current_item = menu.current_item
+
+    if item.nil?
+      !@current_item.nil?
+    else
+      @current_item == item
+    end
+  end
+
+  description do
+    "have a current item"
+  end
+
+  failure_message do
+    if item.nil?
+      <<~EOL
+        expected a current item, but no current item was found
+      EOL
+    else
+      <<~EOL
+        expected: #{item.url}
+          actual: #{actual}
+      EOL
+    end
+  end
+
+  failure_message_when_negated do
+    if item.nil?
+      <<~EOL
+        expected: no current item
+          actual: #{actual}
+      EOL
+    else
+      <<~EOL
+        expected: url != #{item.url}
+          actual: #{actual}
+      EOL
+    end
+  end
+
+  def actual
+    if @current_item.nil?
+      "nil"
+    else
+      @current_item.url
+    end
+  end
+end

data/spec/support/navtastic_store.rb

@@ -0,0 +1,6 @@
+# Remove all stored menus before every test
+RSpec.configure do |config|
+  config.before(:each) do
+    Navtastic.instance_variable_get(:@menu_store).clear
+  end
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: navtastic
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Aram Visser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: arbre
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.48'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.48'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: 
+email: hello@aramvisser.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".circleci/config.yml"
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/navtastic.rb
+- lib/navtastic/item.rb
+- lib/navtastic/menu.rb
+- lib/navtastic/renderer.rb
+- lib/navtastic/version.rb
+- navtastic.gemspec
+- spec/demo/index.rhtml
+- spec/demo/server.rb
+- spec/navtastic/item_spec.rb
+- spec/navtastic/menu_spec.rb
+- spec/navtastic/renderer_spec.rb
+- spec/navtastic_spec.rb
+- spec/spec_helper.rb
+- spec/support/matchers/current_item.rb
+- spec/support/navtastic_store.rb
+homepage: http://github.com/aramvisser/navtastic
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Define and render complex navigation menus
+test_files:
+- spec/demo/index.rhtml
+- spec/demo/server.rb
+- spec/navtastic/item_spec.rb
+- spec/navtastic/menu_spec.rb
+- spec/navtastic/renderer_spec.rb
+- spec/navtastic_spec.rb
+- spec/spec_helper.rb
+- spec/support/matchers/current_item.rb
+- spec/support/navtastic_store.rb