Refs #5586 @4h; First `action_links` refactor

- Implement new API
- Migrate the LineDecorator
- ensure no change on the "lines/index" view

1 files changed, 423 insertions, 0 deletions

diff --git a/spec/lib/af83/decorator/decorator_spec.rb b/spec/lib/af83/decorator/decorator_spec.rb
new file mode 100644
index 000000000..2e046b004
--- /dev/null
+++ b/spec/lib/af83/decorator/decorator_spec.rb
@@ -0,0 +1,423 @@
+RSpec.describe AF83::Decorator, type: :decorator do
+  describe(:parse_options) do
+    let(:options){
+      {primary: true, secondary: %i(index show), permission: :blublu, weight: 12}
+    }
+    let(:link_options){
+      {foo: :foo, bar: :bar}
+    }
+    let(:args){ options.dup.update(link_options.dup) }
+    it "should separate options from link_options" do
+      _options, _link_options = AF83::Decorator.send :parse_options, args
+      expect(_options).to eq options
+      link_options.each do |k, v|
+        expect(_link_options[k]).to eq v
+      end
+    end
+  end
+
+  link_should_match_options = ->(link, options){
+    options.each do |k, v|
+      expect(link.send(k)).to eq v
+    end
+  }
+
+  describe(:action_links) do
+    let(:decorated) do
+      obj = create :line
+      decorator.decorate(obj)
+    end
+
+    context "without links" do
+      let(:decorator) do
+        Class.new(AF83::Decorator)
+      end
+
+      it "should return no link" do
+        links = decorated.action_links
+        expect(links.size).to eq 0
+      end
+    end
+
+    context "with a single link" do
+      let(:link_options) do
+        {
+          href: "/foo/bar",
+          content: "Blublu"
+        }
+      end
+
+      context "incompletetly defined" do
+        let(:decorator) do
+          klass = Class.new(AF83::Decorator)
+          klass.action_link href: "bar"
+          klass
+        end
+
+        it "should raise an error" do
+          expect{decorator}.to raise_error(AF83::Decorator::IncompleteLinkDefinition)
+        end
+      end
+
+      context "defined inline" do
+        let(:decorator) do
+          klass = Class.new(AF83::Decorator)
+          klass.action_link link_options
+          klass
+        end
+
+        it "should return the defined link" do
+          links = decorated.action_links
+          expect(links.size).to eq 1
+          instance_exec links.first, link_options, &link_should_match_options
+        end
+      end
+
+      context "defined in a block" do
+        let(:decorator) do
+          klass = Class.new(AF83::Decorator)
+          klass.action_link do |l|
+            l.href link_options[:href]
+            l.content link_options[:content]
+          end
+          klass
+        end
+
+        it "should return the defined link" do
+          links = decorated.action_links
+          expect(links.size).to eq 1
+          instance_exec links.first, link_options, &link_should_match_options
+        end
+      end
+
+      context "with proc attributes" do
+        let(:decorator) do
+          klass = Class.new(AF83::Decorator)
+          klass.action_link do |l|
+            l.href { context[:href] }
+            l.content link_options[:content]
+          end
+          klass
+        end
+
+        let(:decorated) do
+          obj = create :line
+          decorator.decorate(obj, context: {href: link_options[:href]})
+        end
+
+        it "should return the defined link" do
+          links = decorated.action_links
+          expect(links.size).to eq 1
+          expect(links.first.href).to eq link_options[:href]
+        end
+      end
+
+      context "with a method attributes" do
+        let(:decorator) do
+          klass = Class.new(AF83::Decorator)
+          klass.action_link do |l|
+            l.href link_options[:href]
+            l.content link_options[:content]
+            l.method :put
+          end
+          klass
+        end
+
+        let(:decorated) do
+          obj = create :line
+          decorator.decorate(obj, context: {href: link_options[:href]})
+        end
+
+        it "should return the defined method" do
+          links = decorated.action_links
+          expect(links.size).to eq 1
+          expect(links.first.method).to eq :put
+        end
+      end
+    end
+
+    context "with 2 links" do
+      let(:link_options_1) do
+        {
+          href: "/foo/bar",
+          content: "Blublu"
+        }
+      end
+
+      let(:link_options_2) do
+        {
+          href: "/foo/bar/baz",
+          content: "Foo"
+        }
+      end
+
+      context "without weight" do
+        let(:decorator) do
+          klass = Class.new(AF83::Decorator)
+          klass.action_link link_options_1
+          klass.action_link link_options_2
+          klass
+        end
+
+        it "should return links in the sequence they were defined" do
+          links = decorated.action_links
+          expect(links.size).to eq 2
+          instance_exec links.first, link_options_1, &link_should_match_options
+          instance_exec links.last, link_options_2, &link_should_match_options
+        end
+      end
+
+      context "with weight" do
+        let(:decorator) do
+          klass = Class.new(AF83::Decorator)
+          klass.action_link link_options_1.update(weight: 10)
+          klass.action_link link_options_2
+          klass
+        end
+
+        it "should return links in the sequence they were defined" do
+          links = decorated.action_links
+          expect(links.size).to eq 2
+          instance_exec links.first, link_options_2, &link_should_match_options
+          instance_exec links.last, link_options_1, &link_should_match_options
+        end
+      end
+
+      context "scoped by action" do
+        let(:decorator) do
+          klass = Class.new(AF83::Decorator)
+          klass.action_link link_options_1.update(action: :index)
+          klass.action_link link_options_2
+          klass
+        end
+
+        it "should only return links defined for the given action" do
+          links = decorated.action_links(:show)
+          expect(links.size).to eq 1
+          instance_exec links.first, link_options_2, &link_should_match_options
+        end
+      end
+
+      context "with a policy" do
+        let(:decorator) do
+          klass = Class.new(AF83::Decorator)
+          klass.action_link href: "foo", content: "foo", policy: :edit
+          klass
+        end
+
+        context "when the policy is not met" do
+          before(:each) do
+            Draper::HelperProxy.any_instance.stub(:policy){
+              klass = Class.new do
+                def edit?
+                  false
+                end
+              end.new
+            }
+          end
+
+          it "should not return the link" do
+            links = decorated.action_links(:show)
+            expect(links.size).to eq 0
+          end
+        end
+
+        context "when the policy is met" do
+          before(:each) do
+            Draper::HelperProxy.any_instance.stub(:policy){
+              klass = Class.new do
+                def edit?
+                  true
+                end
+              end.new
+            }
+          end
+
+          it "should not return the link" do
+            links = decorated.action_links(:show)
+            expect(links.size).to eq 1
+          end
+        end
+      end
+
+      context "with a condition" do
+        context "set with 'with_condition'" do
+          context "as a value" do
+            context "when the condition is true" do
+              let(:decorator) do
+                klass = Class.new(AF83::Decorator)
+                klass.with_condition true do
+                  action_link href: "foo", content: "foo"
+                end
+                klass
+              end
+
+              it "should return the link" do
+                links = decorated.action_links(:show)
+                expect(links.size).to eq 1
+              end
+            end
+
+            context "when the condition is false" do
+              let(:decorator) do
+                klass = Class.new(AF83::Decorator)
+                klass.with_condition false do
+                  action_link href: "foo", content: "foo"
+                end
+                klass
+              end
+
+              it "should not return the link" do
+                links = decorated.action_links(:show)
+                expect(links.size).to eq 0
+              end
+            end
+          end
+
+          context "as a Proc" do
+            let(:decorator) do
+              klass = Class.new(AF83::Decorator)
+              klass.with_condition ->{context[:show_link]} do
+                action_link href: "foo", content: "foo"
+              end
+              klass
+            end
+
+            context "when the condition is true" do
+              let(:decorated) do
+                obj = create :line
+                decorator.decorate(obj, context: {show_link: true})
+              end
+
+              it "should return the link" do
+                links = decorated.action_links(:show)
+                expect(links.size).to eq 1
+              end
+            end
+
+            context "when the condition is false" do
+              let(:decorated) do
+                obj = create :line
+                decorator.decorate(obj, context: {show_link: false})
+              end
+
+              it "should not return the link" do
+                links = decorated.action_links(:show)
+                expect(links.size).to eq 0
+              end
+            end
+          end
+        end
+
+        context "set inline" do
+          context "as a value" do
+            context "when the condition is true" do
+              let(:decorator) do
+                klass = Class.new(AF83::Decorator)
+                klass.action_link link_options_1.update(if: true)
+                klass
+              end
+
+              it "should return the link" do
+                links = decorated.action_links(:show)
+                expect(links.size).to eq 1
+              end
+            end
+
+            context "when the condition is false" do
+              let(:decorator) do
+                klass = Class.new(AF83::Decorator)
+                klass.action_link link_options_1.update(if: false)
+                klass
+              end
+
+              it "should not return the link" do
+                links = decorated.action_links(:show)
+                expect(links.size).to eq 0
+              end
+            end
+          end
+
+          context "as a Proc" do
+            let(:decorator) do
+              klass = Class.new(AF83::Decorator)
+              klass.action_link link_options_1.update(if: ->{context[:show_link]})
+              klass
+            end
+
+            context "when the condition is true" do
+              let(:decorated) do
+                obj = create :line
+                decorator.decorate(obj, context: {show_link: true})
+              end
+
+              it "should return the link" do
+                links = decorated.action_links(:show)
+                expect(links.size).to eq 1
+              end
+            end
+
+            context "when the condition is false" do
+              let(:decorated) do
+                obj = create :line
+                decorator.decorate(obj, context: {show_link: false})
+              end
+
+              it "should not return the link" do
+                links = decorated.action_links(:show)
+                expect(links.size).to eq 0
+              end
+            end
+          end
+        end
+      end
+
+      context "scoped by action" do
+        context "with a single action" do
+          let(:decorator) do
+            klass = Class.new(AF83::Decorator)
+            klass.action_link link_options_1.update(action: :index)
+            klass.action_link link_options_2
+            klass
+          end
+
+          it "should only return links defined for the given action" do
+            links = decorated.action_links(:show)
+            expect(links.size).to eq 1
+            instance_exec links.first, link_options_2, &link_should_match_options
+          end
+        end
+
+        context "with several actions" do
+          let(:decorator) do
+            klass = Class.new(AF83::Decorator)
+            klass.action_link link_options_1.update(actions: %i(index edit))
+            klass.action_link link_options_2.update(actions: %i(show edit))
+            klass
+          end
+
+          it "should only return links defined for the given action" do
+            links = decorated.action_links(:show)
+            expect(links.size).to eq 1
+            instance_exec links.first, link_options_2, &link_should_match_options
+          end
+        end
+
+        context "with the keyword 'on'" do
+          let(:decorator) do
+            klass = Class.new(AF83::Decorator)
+            klass.action_link link_options_1.update(on: %i(index edit))
+            klass.action_link link_options_2.update(on: :show)
+            klass
+          end
+
+          it "should only return links defined for the given action" do
+            links = decorated.action_links(:show)
+            expect(links.size).to eq 1
+            instance_exec links.first, link_options_2, &link_should_match_options
+          end
+        end
+      end
+    end
+  end
+end