breadcrumby 0.1.0

data/spec/lib/breadcrumby/models/viewer/i18n_action_name_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Breadcrumby::Viewer, '.i18n_action_name' do
+  subject { described_class.new object, options, view }
+
+  let!(:object)  { build :school }
+  let!(:options) { {} }
+  let!(:view)    { double }
+  let!(:action)  { :edit }
+
+  before do
+    allow(I18n).to receive(:t).with(:edit) { 'edit' }
+
+    allow(I18n).to receive(:t).with(
+      'actions.edit.name', scope: [:breadcrumby], default: 'edit'
+    ) { 'root || edit' }
+
+    allow(I18n).to receive(:t).with(
+      'actions.edit.name', scope: [:breadcrumby, 'school'], default: 'root || edit'
+    ) { 'translation' }
+  end
+
+  it 'returns a name for object fetched from i18n with root fallback' do
+    expect(subject.i18n_action_name(object, action)).to eq 'translation'
+  end
+end

data/spec/lib/breadcrumby/models/viewer/i18n_name_spec.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Breadcrumby::Viewer, '.i18n_name' do
+  subject { described_class.new object, options, view }
+
+  let!(:object)  { build :school }
+  let!(:options) { {} }
+  let!(:view)    { double }
+
+  context 'when :method_name responds with value' do
+    before do
+      allow(object).to receive(:breadcrumby_options) do
+        {
+          i18n_key:    :i18n_key,
+          method_name: :custom_method_name
+        }
+      end
+
+      allow(I18n).to receive(:t).with(:edit, default: 'Edition') { 'edit || Edition' }
+
+      allow(I18n).to receive(:t).with(
+        :name, scope: %i[breadcrumby i18n_key], default: :custom_method_name
+      ) { 'translation' }
+    end
+
+    it 'uses the returned value as the object name' do
+      expect(subject.i18n_name(object)).to eq 'translation'
+    end
+  end
+
+  context 'when :method_name does not respond with value' do
+    before do
+      allow(object).to receive(:breadcrumby_options) do
+        {
+          i18n_key:    :i18n_key,
+          method_name: :custom_method_name_nil
+        }
+      end
+
+      allow(I18n).to receive(:t).with(:edit, default: 'Edition') { 'edit || Edition' }
+
+      allow(I18n).to receive(:t).with(
+        :name, scope: %i[breadcrumby i18n_key], default: '--'
+      ) { 'translation' }
+    end
+
+    it 'uses a default name as fallback' do
+      expect(subject.i18n_name(object)).to eq 'translation'
+    end
+  end
+end

data/spec/lib/breadcrumby/models/viewer/item_options_spec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Breadcrumby::Viewer, '.item_options' do
+  subject { described_class.new object }
+
+  let!(:object) { build :school }
+
+  it 'returns the options used on list element' do
+    expect(subject.item_options).to eq(
+      itemprop:  :itemListElement,
+      itemscope: true,
+      itemtype:  'http://schema.org/ListItem'
+    )
+  end
+end

data/spec/lib/breadcrumby/models/viewer/item_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Breadcrumby::Viewer, '.item' do
+  subject { described_class.new object }
+
+  let!(:content) { :content }
+  let!(:object)  { build :school }
+
+  it 'returns a item element as node of the list' do
+    expect(subject.item(content)).to have_tag :li, with: {
+      itemprop:  :itemListElement,
+      itemscope: :itemscope,
+      itemtype:  'http://schema.org/ListItem'
+    } do
+      with_text :content
+    end
+  end
+
+  context 'when options is given' do
+    let!(:options) { { alt: :custom } }
+
+    it 'is used' do
+      expect(subject.item(content, options)).to have_tag :li, with: { alt: :custom } do
+        with_text :content
+      end
+    end
+  end
+end

data/spec/lib/breadcrumby/models/viewer/link_action_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Breadcrumby::Viewer, '.link_action' do
+  subject { described_class.new object, options }
+
+  let!(:action)  { :edit }
+  let!(:object)  { build :school }
+  let!(:options) { {} }
+
+  context 'when action is not given' do
+    it 'returns the object show route' do
+      expect(subject.link_action(object, nil)).to eq object.show_path
+    end
+  end
+
+  context 'when action is given' do
+    it 'returns an avoid link' do
+      expect(subject.link_action(object, action)).to eq 'javascript:void(0);'
+    end
+  end
+end

data/spec/lib/breadcrumby/models/viewer/link_options_spec.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Breadcrumby::Viewer, '.link_options' do
+  subject { described_class.new object }
+
+  let!(:object) { build :school }
+
+  before do
+    allow(subject).to receive(:i18n_name).with(object) { :i18n_name }
+  end
+
+  context 'when action is not given' do
+    let!(:action) { nil }
+
+    before do
+      allow(I18n).to receive(:t).with(:title, scope: [:breadcrumby, 'school'], name: :i18n_name, default: 'title') { 'breadcrumby.school.title' }
+      allow(I18n).to receive(:t).with(:title, scope: [:breadcrumby]) { 'title' }
+    end
+
+    it 'returns the link options' do
+      expect(subject.link_options(object, action)).to eq(
+        itemprop:  :item,
+        itemscope: true,
+        itemtype:  'http://schema.org/Thing',
+        title:     'breadcrumby.school.title'
+      )
+    end
+  end
+
+  context 'when action is given' do
+    let!(:action) { :edit }
+
+    before do
+      allow(I18n).to receive(:t).with('actions.edit.title', scope: [:breadcrumby, 'school'], name: :i18n_name, default: 'breadcrumby.actions.edit.title') { 'breadcrumby.school.actions.edit.title' }
+      allow(I18n).to receive(:t).with('actions.edit.title', scope: [:breadcrumby]) { 'breadcrumby.actions.edit.title' }
+    end
+
+    it 'returns the link options with title scoped by action fetched from i18n with root fallback' do
+      expect(subject.link_options(object, action)).to eq(
+        itemprop:  :item,
+        itemscope: true,
+        itemtype:  'http://schema.org/Thing',
+        title:     'breadcrumby.school.actions.edit.title'
+      )
+    end
+  end
+end

data/spec/lib/breadcrumby/models/viewer/link_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Breadcrumby::Viewer, '.link' do
+  subject { described_class.new object, options }
+
+  let!(:action)  { :edit }
+  let!(:object)  { build :school }
+  let!(:options) { {} }
+
+  context 'when action is not given' do
+    before do
+      allow(subject).to receive(:i18n_name).with(object) { :i18n_name }
+      allow(subject).to receive(:link_options).with(object, nil) { { class: :custom } }
+    end
+
+    it 'build a link with object properties' do
+      expect(subject.link(object)).to have_tag(:a, with: { href: 'school.show.path' }) do
+        with_tag(:span, with: { itemprop: 'name' }) do
+          with_text 'i18n_name'
+        end
+      end
+    end
+  end
+
+  context 'when action is given' do
+    before do
+      allow(subject).to receive(:i18n_action_name).with(object, action) { :i18n_action_name }
+    end
+
+    it 'build a link with object and action properties' do
+      expect(subject.link(object, action: action)).to have_tag(:a, with: { itemprop: 'item', itemscope: 'itemscope', itemtype: 'http://schema.org/Thing', title: 'translation missing: en.breadcrumby.actions.edit.title', href: 'javascript:void(0);' }) do
+        with_tag(:span, with: { itemprop: 'name' }) do
+          with_text 'i18n_action_name'
+        end
+      end
+    end
+  end
+end

data/spec/lib/breadcrumby/models/viewer/link_tag_name_options_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Breadcrumby::Viewer, '.link_tag_name_options' do
+  subject { described_class.new object }
+
+  let!(:object) { build :school }
+
+  it 'returns options used on link' do
+    expect(subject.link_tag_name_options).to eq(itemprop: :name)
+  end
+end

data/spec/lib/breadcrumby/models/viewer/link_tag_name_spec.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Breadcrumby::Viewer, '.link_tag_name' do
+  subject { described_class.new object, options }
+
+  let!(:action)  { :edit }
+  let!(:object)  { build :school }
+  let!(:options) { {} }
+
+  context 'when action is not given' do
+    before do
+      allow(subject).to receive(:i18n_name).with(object) { :i18n_name }
+    end
+
+    it 'build a ta name with object properties' do
+      expect(subject.link_tag_name(object, nil)).to have_tag(:span, with: { itemprop: 'name' }) do
+        with_text 'i18n_name'
+      end
+    end
+  end
+
+  context 'when action is given' do
+    before do
+      allow(subject).to receive(:i18n_action_name).with(object, action) { :i18n_action_name }
+    end
+
+    it 'build a ta name with object and action properties' do
+      expect(subject.link_tag_name(object, action)).to have_tag(:span, with: { itemprop: 'name' }) do
+        with_text 'i18n_action_name'
+      end
+    end
+  end
+end

data/spec/lib/breadcrumby/models/viewer/list_options_spec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Breadcrumby::Viewer, '.list_options' do
+  subject { described_class.new object }
+
+  let!(:object) { build :school }
+
+  it 'returns the options used on list element' do
+    expect(subject.list_options).to eq(
+      class:     :breadcrumby,
+      itemscope: true,
+      itemtype:  'http://schema.org/BreadcrumbList'
+    )
+  end
+end

data/spec/lib/breadcrumby/models/viewer/meta_spec.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Breadcrumby::Viewer, '.meta' do
+  subject { described_class.new object }
+
+  let!(:index)  { 7 }
+  let!(:object) { build :school }
+
+  it 'returns a meta element used to count the crumbs' do
+    expect(subject.meta(index)).to have_tag :meta, with: { content: 7, itemprop: :position }
+  end
+end

data/spec/lib/breadcrumby/models/viewer/object_extra_spec.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Breadcrumby::Viewer, '.object_extra(0)' do
+  context 'when :action is empty' do
+    subject { described_class.new object, options }
+
+    let!(:object)  { {} }
+    let!(:options) { {} }
+
+    it 'returns an empty array' do
+      expect(subject.object_extra(0)).to eq []
+    end
+  end
+
+  context 'when :action is given' do
+    subject { described_class.new object, options }
+
+    let!(:object) { create :unit }
+
+    context 'with normal relationship' do
+      let!(:options) { { action: :edit } }
+
+      before { Unit.class_eval { breadcrumby } }
+
+      it 'builds the :action crumb' do
+        result = subject.object_extra(0)
+
+        expect(result.size).to eq 1
+
+        expect(result[0]).to have_tag(:li, with: { itemprop: 'itemListElement', itemscope: 'itemscope', itemtype: 'http://schema.org/ListItem' }) do
+          with_tag(:a, with: { itemprop: 'item', itemscope: 'itemscope', itemtype: 'http://schema.org/Thing', title: 'translation missing: en.breadcrumby.actions.edit.title', href: 'javascript:void(0);' }) do
+            with_tag(:span, with: { itemprop: 'name' }) do
+              with_text 'translation missing: en.edit'
+            end
+          end
+
+          with_tag(:meta, with: { content: '1', itemprop: 'position' })
+        end
+      end
+    end
+
+    context 'with no relationship as a new record' do
+      let!(:options) { { action: :new } }
+
+      before do
+        Unit.class_eval do
+          breadcrumby actions: { new: ->(_view) { School.last } }
+        end
+      end
+
+      it 'builds the :action crumb' do
+        result = subject.object_extra(0)
+
+        expect(result.size).to eq 2
+
+        expect(result[0]).to have_tag(:li, with: { itemprop: 'itemListElement', itemscope: 'itemscope', itemtype: 'http://schema.org/ListItem' }) do
+          with_tag(:a, with: { itemprop: 'item', itemscope: 'itemscope', itemtype: 'http://schema.org/Thing', title: 'translation missing: en.breadcrumby.actions.index.title', href: 'unit.index.path' }) do
+            with_tag(:span, with: { itemprop: 'name' }) do
+              with_text 'translation missing: en.index'
+            end
+          end
+
+          with_tag(:meta, with: { content: '1', itemprop: 'position' })
+        end
+
+        expect(result[1]).to have_tag(:li, with: { itemprop: 'itemListElement', itemscope: 'itemscope', itemtype: 'http://schema.org/ListItem' }) do
+          with_tag(:a, with: { itemprop: 'item', itemscope: 'itemscope', itemtype: 'http://schema.org/Thing', title: 'translation missing: en.breadcrumby.actions.new.title', href: 'javascript:void(0);' }) do
+            with_tag(:span, with: { itemprop: 'name' }) do
+              with_text 'translation missing: en.new'
+            end
+          end
+
+          with_tag(:meta, with: { content: '2', itemprop: 'position' })
+        end
+      end
+    end
+  end
+end

data/spec/lib/breadcrumby/models/viewer/scope_spec.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Breadcrumby::Viewer, '.scope' do
+  subject { described_class.new object }
+
+  let!(:object) { build :school }
+
+  context 'with default :i18n_key' do
+    it 'returns a i18n scope path based on class name' do
+      expect(subject.scope(object)).to eq [:breadcrumby, 'school']
+    end
+  end
+
+  context 'with custom :i18n_key' do
+    before do
+      allow(object).to receive(:breadcrumby_options) { { i18n_key: :custom } }
+    end
+
+    it 'returns a i18n scope path based on given name' do
+      expect(subject.scope(object)).to eq %i[breadcrumby custom]
+    end
+  end
+
+  context 'when :include_model is false' do
+    before do
+      allow(object).to receive(:breadcrumby_options) { { i18n_key: :custom } }
+    end
+
+    it 'returns a i18n scope path with only root key' do
+      expect(subject.scope(object, include_model: false)).to eq %i[breadcrumby]
+    end
+  end
+end