nexter 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4900260b077482ad9229eaef70c81eb7a5d84cb
-  data.tar.gz: 350f56554e30064f974872056b7201cd37666a89
+  metadata.gz: e4fadddadc452b36c498da25fdface6c1184c400
+  data.tar.gz: 310cfda6c5d6d65522523d37a75fa8df47e242ff
 SHA512:
-  metadata.gz: dbdb94b58cc46a2aa2ccb20b1cb2a558de630c5f43fd4078b1bb06b508413fcce155dfa6c2af9235828d2fe8eaab20b6df90ee3f4eae96334849c14b0520254c
-  data.tar.gz: 56263b5b0f2d217fc7c7d5b259ac76d836be5e7ea1cabf0e9f3660367942c4d482e237ee4815de3f39c020cc35f3f44556518c5aace9f20732d2e8536152c50e
+  metadata.gz: ec5355bf5157d6166813f1c3b04658556b042a03027538fa0ae40106bb196f9a16faa4cb8ae77dfdbd292c9f26cc3e9bafd556ff9900ee6b2e995fcda671a6d9
+  data.tar.gz: 2bf61ef5f7d480dedc2b2761d805903422c082a7b30cdf8f382f44bf3412a004837f360da9b5c97784db387628882e287cbef4758b56ad86379d475ac9229f51

data/.gitignore

@@ -1,3 +1,4 @@
+.DS_Store
 *.gem
 *.rbc
 .bundle

data/.travis.yml

@@ -3,7 +3,7 @@ rvm:
   - "1.9.3"
   - "2.0.0"
   #- jruby-18mode # JRuby in 1.8 mode
-  - jruby-19mode # JRuby in 1.9 mode
+  #- jruby-19mode # JRuby in 1.9 mode
   #- rbx
 # uncomment this line if your project needs to run something other than `rake`:
 # script: bundle exec rspec spec

data/README.md

@@ -3,13 +3,14 @@
 [![Gem Version](https://badge.fury.io/rb/nexter.png)](http://badge.fury.io/rb/nexter)
 [![Build Status](https://travis-ci.org/charly/nexter.png?branch=master)](https://travis-ci.org/charly/nexter)
 
-What is Nexter ? A misspelled tv show or a killer feature ? Not sure but it wraps your ActiveRecord model with an ordered scope and consistently cuts out the _next_ and _previous_ records. It also works with associations & nested columns : `order("books.genre, authors.name, published_at desc")` 
+What is Nexter ? A misspelled tv show or a killer feature ? Not sure but it wraps your ActiveRecord model with an ordered scope and consistently cuts out the _next_ and _previous_ records. It also works with associations & nested columns : `Book.order("books.genre, authors.name, published_at desc")` 
 
 ## Installation
 
     gem 'nexter'
+    # (edge) gem 'nexter', git: 'https://github.com/charly/nexter'
 
-## Usage
+## Bare Usage
 
 ```ruby
 @books = Book.includes(:author).bestsellers.
@@ -20,9 +21,34 @@ nexter.previous
 nexter.next
 ```
 
-## Use Case Full Stack
+## Rails Usage
 
-It helps you cycle consistentely through each record of any filtered collection instead of helplessly hit the back button of your browser to find the next item of your search. It plays well with gem which keeps the state of an `ActiveRelation like [siphon](https://github.com/charly/siphon), [ransack](https://github.com/activerecord-hackery/ransack), [has_scope](https://github.com/plataformatec/has_scope) & others.
+It helps you cycle consistentely through each record of any filtered collection instead of helplessly hit the back button of your browser to find the next item of your search. It plays well with gem which keeps the state of an `ActiveRelation` like [siphon](https://github.com/charly/siphon), [ransack](https://github.com/activerecord-hackery/ransack) & others.
+
+### New way (bleeding edge)
+
+With the new view helper `nexter` no need to inject previous/next in the ActiveRecord model.
+However there's an assumptions : the formobject responds to `result` and returns an activerelation (like ransack does)
+
+```ruby
+class BookController
+  before_filter :resource, except: :index
+
+  def resource
+    @book_search ||= BookSearch.new(params[:book_search])
+    @book ||= Book.includes([:author]).find(params[:id])
+  end
+end
+```
+
+```erb
+<%- nexter @book, @book_search do |b| %>
+  <%= link_to "previous",   b.path([:edit, :admin, (b.previous || @book)]) %>
+  <%= link_to "collection", b.path([:admin, Book]) %>
+  <%= link_to "next",       b.path([:edit, :admin, (b.next || @book)])
+```
+
+### Old way (still applies but verbose)
 
 ```ruby
 class Book
@@ -62,9 +88,12 @@ end
 
 ## TODO
 
+- (feature) group/havings logic
+- (test) viewhelper
 - (docs) How it works
 - (feature) Joins ?
 - (docs) previous/next through ctrl (not preloaded)
+- (fix) for nil values you need a reorder with default delimiter
 
 ## Contributing
 

data/lib/nexter.rb

@@ -1,10 +1,13 @@
 require "bundler/setup"
 
 require "active_support/core_ext"
+require "active_support/dependencies"
 
 require "nexter/version"
 require "nexter/wrap"
 require "nexter/derange"
+require "nexter/compass"
+require "nexter/eyecontact"
 
 
 module Nexter

data/lib/nexter/compass.rb

@@ -0,0 +1,31 @@
+module Nexter
+  #
+  #
+  #
+  class Compass
+
+    attr_accessor :goto, :direction
+
+    DIREC  = {asc: 1, desc: -1}
+    GOTO = {next: 1, previous: -1}
+
+    def initialize(goto)
+      @goto = goto
+    end
+
+    def bracket
+      signature == -1 ? '<' : '>'
+    end
+
+    def redirection
+      signature == -1 ? 'desc' : 'asc'
+    end
+
+    private
+
+    def signature
+      DIREC[direction.to_sym] * GOTO[goto]
+    end
+  end
+end
+

data/lib/nexter/derange.rb

@@ -1,21 +1,37 @@
 module Nexter
   class Derange
 
-    attr_reader :model, :table_name
+    attr_reader :model, :compass, :table_name, :reorder
 
-    attr_accessor :delimiter, :columns
+    attr_accessor :delimiter, :columns, :trunks
 
-    attr_accessor :sign, :direction, :trunks
+    delegate :goto, :bracket, :redirection, to: :compass
 
-    def initialize(model)
+
+    def initialize(model, goto)
       @model = model
       @table_name = model.class.table_name
       @trunks = []
+      @reorder = false
+      @or_null = false
+      @compass = Nexter::Compass.new(goto)
     end
 
-    def trunk
-      raise unless columns
+    def set_vals(order_vals, order_col)
+      @columns = order_vals
+      @delimiter = order_col[0]
+      compass.direction = order_col[1]
+    end
 
+    def where
+      "(#{range} #{range.blank? ? '' : 'AND'} #{slice})"
+    end
+
+    def reorder
+      " #{delimiter} #{redirection}"
+    end
+
+    def range
       trunk = columns.map do |col|
         if range_value = value_of(col[0])
           "#{col[0]} = '#{range_value}'"
@@ -23,29 +39,25 @@ module Nexter
           "#{col[0]} IS NULL"
         end
       end.join(' AND ')
-
-      trunks << trunk
-      "#{trunk} AND" unless trunk.blank?
     end
 
-    def bigger_than
-      if delimiter_value = value_of(delimiter)
-        "#{delimiter} #{get_bracket(sign)} '#{delimiter_value}'"
+    def slice
+      if val = value_of(delimiter)
+        d = val.is_a?(String) ? val.gsub(/'/, "''") : val
+        delimited = "#{delimiter} #{bracket} '#{d}'"
       else
+        # @reorder = true
         "#{delimiter} IS NULL AND #{table_name}.id > #{model.id}"
       end
     end
 
-    def get_bracket(sign)
-      sign == -1 ? '<' : '>'
-    end
-
     def value_of(cursor)
       splits = cursor.split(".")
-      if splits.first == table_name || splits.size == 1
+      result = if splits.first == table_name || splits.size == 1
         model.send(splits.last)
       else
-        asso = model.reflections.keys.grep(/#{splits.first.singularize}/).first
+        # binding.pry
+        asso = model.class.reflections.keys.grep(/#{splits.first.singularize}/).first
         asso = model.send(asso) and asso.send(splits.last)
       end
     end

data/lib/nexter/eyecontact.rb

@@ -0,0 +1,55 @@
+module Nexter
+  # ViewHelper/ViewBuilder for previous/next out of the van
+  #
+  # - nexter(@asset, @asset_search) do |asset|
+  #   = link_to "previous", asset.path([:edit, :admin, asset.previous ])
+  #   = link_to "next", asset.path([:edit, :admin, asset.next ])
+  #
+  module Eyecontact
+
+    def nexter( model, search_form )
+      yield Nexter::Retina.new(model, search_form, self)
+      return false
+    end
+
+    ::ActionView::Base.send(:include, self) if defined?(Rails)
+  end
+
+  class Retina
+    attr_reader :model, :search_form, :view
+
+    attr_reader :relation, :params
+
+    attr_reader :nexter
+
+    delegate :previous, :next, :after, :before, :to => :nexter
+
+    def initialize( model, search_form, view)
+      @model = model
+      @search_form = search_form
+      @view = view
+
+      set_relation
+      set_params
+
+      @nexter = Nexter.wrap( relation, model )
+    end
+
+    def path(args)
+      @view.polymorphic_path(args, params)
+    end
+
+
+  private
+
+    def set_relation
+      @relation = @search_form.result
+    end
+
+    def set_params
+      param_key = @search_form.class.model_name.param_key
+      @params = view.params.select {|k, v| k == param_key}
+    end
+  end
+end
+

data/lib/nexter/version.rb

@@ -1,3 +1,3 @@
 module Nexter
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/nexter/wrap.rb

@@ -1,9 +1,6 @@
 module Nexter
   class Wrap
 
-    # the gui concatenating strings
-    attr_reader :derange
-
     # the current model & the scope
     attr_reader :model, :relation
 
@@ -13,19 +10,18 @@ module Nexter
     # list of build strings for finale SQL
     attr_reader :wheres, :reorders
 
-    DIREC  = {asc: 1, desc: -1}
-    GOTO = {next: 1, previous: -1}
 
     def initialize(relation, model)
       @relation = relation
       @model = model
-      @order_values = arrayize( relation.order_values )
+      @order_values = parse_order( relation.order_values )
       @associations = relation.includes_values
       # @cursor_column = extract_attr( @ranges.pop )
       # @cursor = model.send( @cursor_column.to_sym, )
-      @derange = Nexter::Derange.new(model)
     end
 
+    # TODO : let user determine which strategy to choose:
+    # e.g: carousel or stay there
     def next
       after.first
     end
@@ -34,10 +30,11 @@ module Nexter
       before.first
     end
 
-
     def after
-      cut(:next)
-      relation.where( wheres.join(' OR ') )
+      derange = cut(:next)
+      r = relation.where( wheres.join(' OR ') )
+      # r = r.order(:id) if derange.reorder
+      r
     end
 
     def before
@@ -54,29 +51,21 @@ module Nexter
       order_vals = @order_values.dup
       @wheres = []
       @reorders = []
+      derange = Nexter::Derange.new(model, goto)
 
       while order_col = order_vals.pop do
+        derange.set_vals(order_vals, order_col)
 
-        derange.columns = order_vals
-        derange.delimiter = order_col[0]
-        derange.direction = order_col[1]
-        derange.sign      = signature(derange.direction, goto)
-
-        wheres << "( #{derange.trunk} #{derange.bigger_than} )"
-        reorders.unshift(" #{order_col[0]} #{get_direction(derange.sign)}")
+        # should be derange's result
+        wheres << derange.where
+        reorders.unshift(derange.reorder)
       end
-    end
-
-    def signature(dir, goto)
-      sign = DIREC[dir.to_sym] * GOTO[goto]
-    end
 
-    def get_direction(sign)
-      sign == -1 ? 'desc' : 'asc'
+      derange
     end
 
     # helper to turn mixed order attributes to a consistant
-    def arrayize(array)
+    def parse_order(array)
       array.join(",").split(",").map(&:strip).map do |column|
         splits = column.split(" ").map(&:strip).map(&:downcase)
         splits << "asc" if splits.size == 1

data/spec/book.rb

@@ -1,5 +1,3 @@
-Author = Struct.new(:name)
-
 Book = Struct.new(:genre, :name, :title) do
 
   def id; 71; end
@@ -13,7 +11,8 @@ Book = Struct.new(:genre, :name, :title) do
   end
 
   def author
-    Author.new("nabokov")
+    a = Struct.new(:name)
+    a.new(name)
   end
 end
 
@@ -36,4 +35,8 @@ class Relation
     self
   end
 
+  def order(args)
+    self
+  end
+
 end

data/spec/nexter/compass_spec.rb

@@ -0,0 +1,34 @@
+require "spec_helper"
+
+describe Nexter::Compass do
+
+  describe "#arrwo or #bracket" do
+    context "when looking for *next*" do
+      let(:compass) {Nexter::Compass.new(:next)}
+
+      it "returns > when direction's *asc*" do
+        compass.direction= "asc"
+        expect(compass.bracket).to eq(">")
+      end
+
+      it "returns < when direction's *desc*" do
+        compass.direction= "desc"
+        expect(compass.bracket).to eq("<")
+      end
+    end
+
+    context "when looking for *previous*" do
+      let(:compass) {Nexter::Compass.new(:previous)}
+
+      it "returns < when direction's *asc*" do
+        compass.direction= "asc"
+        expect(compass.bracket).to eq("<")
+      end
+
+      it "returns > when direction's *desc*" do
+        compass.direction= "desc"
+        expect(compass.bracket).to eq(">")
+      end
+    end
+  end # desc
+end

data/spec/nexter/derange_spec.rb

@@ -0,0 +1,53 @@
+require "spec_helper"
+
+describe Nexter::Derange do
+
+    let(:relation) { Relation.new }
+    let(:book)     { Book.new("novel", "nabokov", "Ada") }
+    let(:nexter)   { Nexter::Wrap.new(relation, book)}
+
+    describe "#range" do
+      it "returns a range of rows related to the current model (book)" do
+        derange = Nexter::Derange.new(book, :next)
+        derange.columns = nexter.order_values.tap(&:pop)
+
+        expect(derange.range).to eq("books.genre = 'novel' AND authors.name = 'nabokov'")
+      end
+
+      it "handles nil values" do
+        book.genre = nil
+        derange = Nexter::Derange.new(book, :next)
+        derange.columns = nexter.order_values.tap(&:pop)
+
+        expect(derange.range).to eq("books.genre IS NULL AND authors.name = 'nabokov'")
+      end
+
+      it "handles nil values (just for peace of mind)" do
+        book.name = nil
+        derange = Nexter::Derange.new(book, :next)
+        derange.columns = nexter.order_values.tap(&:pop)
+
+        expect(derange.range).to eq("books.genre = 'novel' AND authors.name IS NULL")
+      end
+    end
+
+    describe "#slice" do
+      it "returns a range of rows related to the current model (book)" do
+        derange = Nexter::Derange.new(book, :next)
+        order_col = nexter.order_values.pop
+        derange.set_vals(nexter.order_values, order_col)
+
+        expect(derange.slice).to eq("books.title > 'Ada'")
+      end
+
+      it "handles nil values" do
+        book.title = nil
+        derange = Nexter::Derange.new(book, :next)
+        order_col = nexter.order_values.pop
+        derange.set_vals(nexter.order_values, order_col)
+
+        expect(derange.slice).to eq("books.title IS NULL AND books.id > 71")
+      end
+    end
+
+end

data/spec/nexter/wrap_spec.rb

@@ -11,8 +11,7 @@ describe Nexter::Wrap do
         nexter = Nexter::Wrap.new(relation, book)
         nexter.after
 
-        expect(nexter.wheres[0]).to eq("( authors.name = 'nabokov' AND title > 'ada' )")
-        expect(nexter.wheres[1]).to eq("(  authors.name > 'nabokov' )")
+        expect(nexter.wheres[0]).to eq("(authors.name = 'nabokov' AND title > 'ada')")
       end
     end
 
@@ -21,7 +20,7 @@ describe Nexter::Wrap do
         nexter = Nexter::Wrap.new(relation, book)
         nexter.before
 
-        expect(nexter.wheres[0]).to eq("( authors.name = 'nabokov' AND title < 'ada' )")
+        expect(nexter.wheres[0]).to eq("(authors.name = 'nabokov' AND title < 'ada')")
       end
 
       it "has the right SQL order by" do
@@ -43,7 +42,7 @@ describe Nexter::Wrap do
         nexter = Nexter::Wrap.new(relation, book)
         nexter.after
 
-        expect(nexter.wheres[0]).to eq("( genre IS NULL AND title > 'Ada' )")
+        expect(nexter.wheres[0]).to eq("(genre IS NULL AND title > 'Ada')")
       end
     end
 
@@ -54,7 +53,7 @@ describe Nexter::Wrap do
         nexter = Nexter::Wrap.new(relation, book)
         nexter.after
 
-        expect(nexter.wheres[0]).to eq("( genre = 'novel' AND title IS NULL AND books.id > #{book.id} )")
+        expect(nexter.wheres[0]).to eq("(genre = 'novel' AND title IS NULL AND books.id > #{book.id})")
       end
     end
 

data/spec/spec_helper.rb

@@ -7,7 +7,7 @@
 require "book"
 require "nexter"
 require "active_support"
-require "pry-rescue/rspec"
+# require "pry-rescue/rspec"
 
 
 RSpec.configure do |config|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexter
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Charles Sistovaris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-09 00:00:00.000000000 Z
+date: 2014-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -127,11 +127,15 @@ files:
 - README.md
 - Rakefile
 - lib/nexter.rb
+- lib/nexter/compass.rb
 - lib/nexter/derange.rb
+- lib/nexter/eyecontact.rb
 - lib/nexter/version.rb
 - lib/nexter/wrap.rb
 - nexter.gemspec
 - spec/book.rb
+- spec/nexter/compass_spec.rb
+- spec/nexter/derange_spec.rb
 - spec/nexter/wrap_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/charly/nexter
@@ -161,6 +165,8 @@ summary: Wrap your model with an ordered scope and cut out the _next_ and _previ
   record.
 test_files:
 - spec/book.rb
+- spec/nexter/compass_spec.rb
+- spec/nexter/derange_spec.rb
 - spec/nexter/wrap_spec.rb
 - spec/spec_helper.rb
 has_rdoc: