navigators 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff2fc169e9e71efcfb7f3e64881516a230f96cf6
+  data.tar.gz: ba2846769c3396d8aae62c0340b9bcef6c0e07f6
+SHA512:
+  metadata.gz: 11d5d8f31c07fd3d87b71996660c13047701138d292cd0ec7cc66252843428a3b879be0d63be716ca229f204b86a7583cf35e759c484f78896ed327c539b028d
+  data.tar.gz: 1a0e6b19af0dff47e01207b80417640cfeb13b59a2ca4fbb71ff5473b5fac662b6c74c7fe13063a62f66e1b0282d5dd97ef4854ad451321444aec3d6f3e1feb3

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in navigators.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 TODO: Write your name
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# Navigators
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'navigators'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install navigators
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/navigators/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/navigators.rb

@@ -0,0 +1,6 @@
+require "navigators/version"
+require "navigators/base"
+
+module Navigators
+  # Your code goes here...
+end

data/lib/navigators/base.rb

@@ -0,0 +1,94 @@
+module Navigators
+  class Base
+    attr_reader :listener
+
+    def initialize(listener)
+      @listener = listener
+    end
+
+    def self.index(listener)
+      self.new(listener).index
+    end
+
+    def index
+      listener.render_resources(get_resources)
+    end
+
+    def self.show(id, listener)
+      self.new(listener).show(id)
+    end
+
+    def show(id)
+      listener.render_resource(get_resource(id))
+    end
+
+    def self.save(params, listener, id=nil)
+      self.new(listener).save(params, id)
+    end
+
+    def save(params, id=nil)
+      @action = id ? :edit : :new
+      get_resource(id)
+
+      if save_resource(params)
+        listener.save_success(resource, success_message)
+      else
+        listener.save_failure(resource, error_message)
+      end
+    end
+
+    def self.destroy(id, listener)
+      self.new(listener).destroy(id)
+    end
+
+    def destroy(id)
+      return false unless id
+
+      get_resource(id)
+      @action = :destroy
+
+      if destroy_resource
+        listener.save_success(resource, success_message)
+      else
+        listener.save_failure(resource, error_message)
+      end
+    end
+
+    protected
+    def success_message
+      "#{action} success"
+    end
+
+    def error_message
+      "#{action} error"
+    end
+
+    def save_resource(params)
+      false
+    end
+
+    def destroy_resource
+      false
+    end
+
+    def get_resource(id=nil)
+      @resource = nil
+    end
+
+    def get_resources(filters={})
+      @resources = []
+    end
+
+    def action
+      @action
+    end
+
+    def resource
+      @resource
+    end
+
+    def resources
+      @resources
+    end
+  end
+end

data/lib/navigators/version.rb

@@ -0,0 +1,3 @@
+module Navigators
+  VERSION = "0.0.1"
+end

data/navigators.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'navigators/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "navigators"
+  spec.version       = Navigators::VERSION
+  spec.authors       = ["Caio Torres"]
+  spec.email         = ["caio.a.torres@gmail.com"]
+  spec.summary       = %q{A Base class to help creating navigators to your application business model}
+  spec.description   = %q{A Base class to help creating navigators to your application business model}
+  spec.homepage      = "https://github.com/efreesen/navigators"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "environments", "~> 0"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "pry-meta", "~> 0"
+end

data/spec/navigators/base_spec.rb

@@ -0,0 +1,197 @@
+require './lib/navigators/base'
+
+describe Navigators::Base do
+  let(:listener) { double }
+
+  describe '#listener' do
+    subject { described_class.new(listener) }
+
+    it 'returns listener' do
+      expect(subject.listener).to eq listener
+    end
+  end
+
+  describe '#index' do
+    let(:collection) { [1, 2, 3] }
+
+    subject { described_class.new(listener) }
+
+    before do
+      allow(subject).to receive(:get_resources).and_return(collection)
+    end
+
+    it 'calls render render_resources method on listener' do
+      expect(listener).to receive(:render_resources).with(collection)
+
+      subject.index
+    end
+  end
+
+  describe '.index' do
+    let(:instance) { described_class.new(listener) }
+
+    before do
+      allow(described_class).to receive(:new).with(listener).and_return(instance)
+    end
+
+    it 'calls #index' do
+      expect(instance).to receive(:index)
+
+      described_class.index(listener)
+    end
+  end
+
+  describe '#save' do
+    context 'when id is passed' do
+      let(:resource) { double }
+      let(:id) { 123456 }
+      let(:params) { { name: 'name', id: 123456 } }
+
+      subject { described_class.new(listener) }
+
+      before do
+        allow(subject).to receive(:resource).and_return(resource)
+      end
+
+      context 'and save is successful' do
+        before do
+          allow(subject).to receive(:save_resource).with(params).and_return(true)
+        end
+
+        it 'calls listener save_success method' do
+          expect(listener).to receive(:save_success).with(resource, 'edit success')
+
+          subject.save(params, id)
+        end
+      end
+
+      context 'and save fails' do
+        before do
+          allow(subject).to receive(:save_resource).with(params).and_return(false)
+        end
+
+        it 'calls listener save_failure method' do
+          expect(listener).to receive(:save_failure).with(resource, 'edit error')
+
+          subject.save(params, id)
+        end
+      end
+    end
+
+    context 'when no id is passed' do
+      let(:resource) { double }
+      let(:params) { { name: 'name' } }
+
+      subject { described_class.new(listener) }
+
+      before do
+        allow(subject).to receive(:resource).and_return(resource)
+      end
+
+      context 'and save is successful' do
+        before do
+          allow(subject).to receive(:save_resource).with(params).and_return(true)
+        end
+
+        it 'calls listener save_success method' do
+          expect(listener).to receive(:save_success).with(resource, 'new success')
+
+          subject.save(params)
+        end
+      end
+
+      context 'and save fails' do
+        before do
+          allow(subject).to receive(:save_resource).with(params).and_return(false)
+        end
+
+        it 'calls listener save_failure method' do
+          expect(listener).to receive(:save_failure).with(resource, 'new error')
+
+          subject.save(params)
+        end
+      end
+    end
+  end
+
+  describe '.save' do
+    let(:instance) { described_class.new(listener) }
+
+    before do
+      allow(described_class).to receive(:new).with(listener).and_return(instance)
+    end
+
+    it 'calls #save' do
+      expect(instance).to receive(:save)
+
+      described_class.save({}, listener, 1)
+    end
+  end
+
+  describe '#destroy' do
+    context 'when id is passed' do
+      let(:resource) { double }
+      let(:id) { 123456 }
+
+      subject { described_class.new(listener) }
+
+      before do
+        allow(subject).to receive(:resource).and_return(resource)
+      end
+
+      context 'and destroy is successful' do
+        before do
+          allow(subject).to receive(:destroy_resource).and_return(true)
+        end
+
+        it 'calls listener save_success method' do
+          expect(listener).to receive(:save_success).with(resource, 'destroy success')
+
+          subject.destroy(id)
+        end
+      end
+
+      context 'and destroy fails' do
+        before do
+          allow(subject).to receive(:destroy_resource).and_return(false)
+        end
+
+        it 'calls listener save_failure method' do
+          expect(listener).to receive(:save_failure).with(resource, 'destroy error')
+
+          subject.destroy(id)
+        end
+      end
+    end
+
+    context 'when no id is passed' do
+      let(:resource) { double }
+      let(:params) { { name: 'name' } }
+
+      subject { described_class.new(listener) }
+
+      before do
+        allow(subject).to receive(:resource).and_return(resource)
+        allow(subject).to receive(:destroy_resource).and_return(false)
+      end
+
+      it 'returns false' do
+        expect(subject.destroy(nil)).not_to be
+      end
+    end
+  end
+
+  describe '.destroy' do
+    let(:instance) { described_class.new(listener) }
+
+    before do
+      allow(described_class).to receive(:new).with(listener).and_return(instance)
+    end
+
+    it 'calls #destroy' do
+      expect(instance).to receive(:destroy)
+
+      described_class.destroy(1, listener)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'rspec'
+require 'pry'
+require 'environments'
+
+Environments.current = 'test'
+
+RSpec.configure do |config|
+  config.order = :random
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+
+    mocks.verify_partial_doubles = true
+    mocks.verify_doubled_constant_names = true
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: navigators
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Caio Torres
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: environments
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: pry-meta
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Base class to help creating navigators to your application business
+  model
+email:
+- caio.a.torres@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/navigators.rb
+- lib/navigators/base.rb
+- lib/navigators/version.rb
+- navigators.gemspec
+- spec/navigators/base_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/efreesen/navigators
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A Base class to help creating navigators to your application business model
+test_files:
+- spec/navigators/base_spec.rb
+- spec/spec_helper.rb