breadcrumby 0.1.0

data/lib/breadcrumby/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Breadcrumby
+  VERSION = '0.1.0'
+end

data/spec/factories/course.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+FactoryGirl.define do
+  factory :course do
+    sequence(:name) { |i| "Course #{i}" }
+
+    school
+  end
+end

data/spec/factories/grade.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+FactoryGirl.define do
+  factory :grade do
+    sequence(:name) { |i| "Grade #{i}" }
+
+    level
+    unit
+  end
+end

data/spec/factories/level.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+FactoryGirl.define do
+  factory :level do
+    sequence(:name) { |i| "Level #{i}" }
+
+    course
+  end
+end

data/spec/factories/school.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+FactoryGirl.define do
+  factory :school do
+    sequence(:name) { |i| "School #{i}" }
+  end
+end

data/spec/factories/unit.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+FactoryGirl.define do
+  factory :unit do
+    sequence(:name) { |i| "Unit #{i}" }
+
+    school
+  end
+end

data/spec/lib/breadcrumby/helpers/breadcrumby_spec.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+class DummyHelper
+  include Breadcrumby::ViewHelper
+end
+
+RSpec.describe DummyHelper, '.breadcrumby' do
+  let!(:object)  { create :school, name: 'School 1' }
+  let!(:options) { { key: :value } }
+  let!(:helper)  { DummyHelper.new }
+  let!(:viewer)  { double Breadcrumby::Viewer, breadcrumb: :breadcrumb }
+
+  before do
+    allow(Breadcrumby::Viewer).to receive(:new).with(object, options, helper) { viewer }
+  end
+
+  it 'calls breadcrumb from viewer' do
+    expect(helper.breadcrumby(object, options)).to eq :breadcrumb
+  end
+end

data/spec/lib/breadcrumby/models/extension/breadcrumby_options_spec.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Breadcrumby::Extension, '.breadcrumby_options' do
+  describe ':i18n_key' do
+    context 'when is not given' do
+      before do
+        stub_const 'Dummy', Class.new
+
+        Dummy.class_eval { include Breadcrumby::Extension }
+        Dummy.class_eval { breadcrumby }
+      end
+
+      it 'uses a default' do
+        expect(Dummy.new.breadcrumby_options[:i18n_key]).to eq 'dummy'
+      end
+    end
+
+    context 'when is given' do
+      before do
+        stub_const 'Dummy', Class.new
+
+        Dummy.class_eval { include Breadcrumby::Extension }
+        Dummy.class_eval { breadcrumby i18n_key: :key }
+      end
+
+      it 'uses the given one' do
+        expect(Dummy.new.breadcrumby_options[:i18n_key]).to eq :key
+      end
+    end
+  end
+
+  describe ':method_name' do
+    context 'when is not given' do
+      before do
+        stub_const 'Dummy', Class.new
+
+        Dummy.class_eval { include Breadcrumby::Extension }
+        Dummy.class_eval { breadcrumby }
+      end
+
+      it 'uses a default' do
+        expect(Dummy.new.breadcrumby_options[:method_name]).to eq :name
+      end
+    end
+
+    context 'when is given' do
+      before do
+        stub_const 'Dummy', Class.new
+
+        Dummy.class_eval { include Breadcrumby::Extension }
+        Dummy.class_eval { breadcrumby method_name: :some_name }
+      end
+
+      it 'uses the given one' do
+        expect(Dummy.new.breadcrumby_options[:method_name]).to eq :some_name
+      end
+    end
+  end
+
+  describe ':actions' do
+    context 'when is not given' do
+      before do
+        stub_const 'Dummy', Class.new
+
+        Dummy.class_eval { include Breadcrumby::Extension }
+        Dummy.class_eval { breadcrumby }
+      end
+
+      it 'uses a default' do
+        expect(Dummy.new.breadcrumby_options[:actions]).to eq({})
+      end
+    end
+
+    context 'when is given' do
+      before do
+        stub_const 'Dummy', Class.new
+
+        Dummy.class_eval { include Breadcrumby::Extension }
+        Dummy.class_eval { breadcrumby actions: { key: :value } }
+      end
+
+      it 'uses the given one' do
+        expect(Dummy.new.breadcrumby_options[:actions]).to eq(key: :value)
+      end
+    end
+  end
+end

data/spec/lib/breadcrumby/models/extension/breadcrumby_spec.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Breadcrumby::Extension, '.breadcrumby' do
+  context 'when object has no path option' do
+    let!(:school) { create :school, name: 'School 1' }
+
+    it 'returns itself' do
+      expect(school.breadcrumby).to eq [school]
+    end
+  end
+
+  context 'when object has an empty path option' do
+    let!(:school) { create :school }
+
+    before { School.class_eval { breadcrumby path: [] } }
+
+    it 'returns itself' do
+      expect(school.breadcrumby).to eq [school]
+    end
+  end
+
+  context 'when object has a nil path option' do
+    let!(:school) { create :school }
+
+    before { School.class_eval { breadcrumby path: nil } }
+
+    it 'returns itself' do
+      expect(school.breadcrumby).to eq [school]
+    end
+  end
+
+  context 'when object is the second level' do
+    let!(:course) { create :course }
+
+    context 'and has one item on path option' do
+      before { Course.class_eval { breadcrumby path: [:school] } }
+
+      it 'returns itself and the parents' do
+        expect(course.breadcrumby).to eq [course, course.school]
+      end
+    end
+
+    context 'and has just one symbol on path option' do
+      before { Course.class_eval { breadcrumby path: :school } }
+
+      it 'returns itself and the parents' do
+        expect(course.breadcrumby).to eq [course, course.school]
+      end
+    end
+  end
+
+  context 'when object is on a deep level' do
+    let!(:school) { create :school }
+    let!(:unit)   { create :unit, school: school }
+    let!(:course) { create :course, school: school }
+    let!(:level)  { create :level, course: course }
+    let!(:grade)  { create :grade, level: level, unit: unit }
+
+    context 'and parents just point to it parent' do
+      before do
+        Course.class_eval { breadcrumby path: :school }
+        Level.class_eval { breadcrumby path: :course }
+        Grade.class_eval { breadcrumby path: :level }
+      end
+
+      it 'returns itself and the parents' do
+        expect(grade.breadcrumby).to eq [grade, grade.level, grade.level.course, grade.level.course.school]
+      end
+    end
+
+    context 'and object points an specific path' do
+      context 'and last parent has no path' do
+        before do
+          # TODO: was need to declare again, site the other Course.class_eval keeped the callback on memory. Why if it is inside a before block?
+          Course.class_eval { breadcrumby }
+          Grade.class_eval { breadcrumby path: %i[course level] }
+        end
+
+        it 'returns itself and the parents until the last parent path' do
+          expect(grade.breadcrumby).to eq [grade, grade.level, grade.level.course]
+        end
+      end
+
+      context 'and last parent has path' do
+        before do
+          Course.class_eval { breadcrumby path: :school }
+          Grade.class_eval { breadcrumby path: %i[course level] }
+        end
+
+        it 'returns itself and the following parents' do
+          expect(grade.breadcrumby).to eq [grade, grade.level, grade.level.course, grade.level.course.school]
+        end
+      end
+
+      context 'and i want follow different paths' do
+        context 'until the end' do
+          before do
+            Unit.class_eval { breadcrumby path: :school }
+            Course.class_eval { breadcrumby path: :school }
+            Level.class_eval { breadcrumby path: :course }
+            Grade.class_eval { breadcrumby path: [[:unit], [:level]] }
+          end
+
+          it 'follows each one of the path groups' do
+            expect(grade.breadcrumby).to eq [grade, grade.level, grade.level.course, grade.level.course.school, grade.unit, grade.level.course.school]
+          end
+        end
+
+        context 'stopping on a specific point' do
+          before do
+            Unit.class_eval { breadcrumby path: :school }
+            Course.class_eval { breadcrumby path: :school }
+            Level.class_eval { breadcrumby path: :course }
+            Grade.class_eval { breadcrumby path: [[:unit], [nil, :course, :level]] }
+          end
+
+          it 'follows each one of the path groups until end of until the nil break point' do
+            expect(grade.breadcrumby).to eq [grade, grade.level, grade.level.course, grade.unit, grade.level.course.school]
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/breadcrumby/models/home/name_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Breadcrumby::Home, '.name' do
+  subject { described_class.new view }
+
+  let!(:view) { double }
+
+  context 'when i18n key is not defined' do
+    it 'returns a default name' do
+      expect(subject.name).to eq 'Home'
+    end
+  end
+
+  context 'when i18n key is defined' do
+    before do
+      allow(I18n).to receive(:t).with('breadcrumby.home.name', default: 'Home') { 'Start' }
+    end
+
+    it 'returns a default name' do
+      expect(subject.name).to eq 'Start'
+    end
+  end
+end

data/spec/lib/breadcrumby/models/home/show_path_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Breadcrumby::Home, '.show_path' do
+  context 'when route :root_path is not present' do
+    subject { described_class.new view }
+
+    let!(:view) { double }
+
+    it 'returns the root path' do
+      expect(subject.show_path).to eq '/'
+    end
+  end
+
+  context 'when route :root_path is present' do
+    subject { described_class.new view }
+
+    let!(:view) { double root_path: :root_path }
+
+    it 'returns the :root_path value' do
+      expect(subject.show_path).to eq :root_path
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Breadcrumby::Viewer, '.breadcrumb' do
+  context 'when object does not respond to :breadcrumby' do
+    subject { described_class.new object, options }
+
+    let!(:object)  { {} }
+    let!(:options) { {} }
+    let!(:view)    { double root_path: :root_path }
+
+    it 'returns an empty string' do
+      expect(subject.breadcrumb).to eq ''
+    end
+  end
+
+  context 'when object responds to :breadcrumby' do
+    subject { described_class.new object, options }
+
+    let!(:object) { create :school, name: 'The School' }
+    let!(:view)   { double root_path: :root_path }
+    let!(:list)   { [object] }
+
+    before do
+      allow(subject).to receive(:breadcrumbs).with(object) { [object] }
+      allow(subject).to receive(:object_extra).with(list.size) { ['<li class="object_extra"></li>'] }
+      allow(subject).to receive(:list_options) { { class: :list_options } }
+    end
+
+    context 'with no :actions' do
+      let!(:options) { {} }
+
+      before do
+        Unit.class_eval { breadcrumby }
+      end
+
+      it 'returns the default breadcrumb' do
+        expect(subject.breadcrumb).to have_tag(:ol, with: { class: 'list_options' }) do
+          with_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.title', href: 'school.show.path' }) do
+              with_tag(:span, with: { itemprop: 'name' }) do
+                with_text 'The School'
+              end
+            end
+
+            with_tag(:meta, with: { content: '1', itemprop: 'position' })
+          end
+
+          with_tag :li, with: { class: 'object_extra' }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Breadcrumby::Viewer, '.breadcrumbs' do
+  subject { described_class.new object, options, view }
+
+  let!(:object)  { build :school }
+  let!(:options) { {} }
+  let!(:view)    { double }
+  let!(:home)    { double Breadcrumby::Home }
+
+  before do
+    Unit.class_eval { breadcrumby }
+
+    allow(Breadcrumby::Home).to receive(:new).with(view) { home }
+  end
+
+  it 'returns the objects including the home' do
+    expect(subject.breadcrumbs(object)).to eq [
+      Breadcrumby::Home.new(view),
+      object
+    ]
+  end
+end

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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Breadcrumby::Viewer, '.current_object' do
+  subject { described_class.new object, options, view }
+
+  let!(:object) { build :school }
+  let!(:view)   { double }
+
+  context 'when object has no :actions' do
+    let!(:options) { {} }
+
+    before { School.class_eval { breadcrumby } }
+
+    it 'returns the self object' do
+      expect(subject.current_object).to eq object
+    end
+  end
+
+  context 'when object has :actions' do
+    before do
+      School.class_eval { breadcrumby actions: {} }
+    end
+
+    context 'but view action is not provided' do
+      let!(:options) { {} }
+
+      it 'returns the self object' do
+        expect(subject.current_object).to eq object
+      end
+    end
+
+    context 'and view action is provided' do
+      let!(:options) { { action: :new } }
+
+      context 'but object has not this action' do
+        it 'returns the self object' do
+          expect(subject.current_object).to eq object
+        end
+      end
+
+      context 'and object has this action' do
+        context 'but actions is not callable' do
+          before do
+            School.class_eval { breadcrumby actions: { new: :uncallable } }
+          end
+
+          it 'returns the self value' do
+            expect(subject.current_object).to eq :uncallable
+          end
+        end
+
+        context 'and actions is callable' do
+          before do
+            School.class_eval do
+              breadcrumby actions: { new: ->(view) { view } }
+            end
+          end
+
+          it 'returns the result call' do
+            expect(subject.current_object).to eq view
+          end
+        end
+      end
+    end
+  end
+end