flexirails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 13cd7f185547a32a1c78255b13533dde98c348a2
+  data.tar.gz: 7566fb2bb29edaf12737db45c5e6c71aeee5df50
+SHA512:
+  metadata.gz: 7168c88257719d55a31be8bd847f12872ab6d4b98de945e789669e1c0a1907cc927209508c2633ba9f09e2f49415f68c21a9529504f48a3817448018bed2b284
+  data.tar.gz: 4e597fe640fbe4c06db3502114f54921375ba73dba8e7dfbb84ead2b789256e94e91bb631122e048a03e5137c0675454b876137beb9b94afadb9b480e6c3541b

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011-2013 Raphael Randschau (nicolai86@me.com)
+
+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,171 @@
+# Flexirails
+
+ORM independent table view for Ruby on Rails.
+Has support for partial rendering, turbolinks and i18n as well as basic sorting and filtering facilities.
+If you want more abstraction you need to build it yourself.
+
+Look at the bright side: want to use bananadb? Go ahead.<br>
+Just wrote your self CSV-In-Memory-DB? No Problem.<br>
+Reading each row from /dev/null. Sure, why not?
+
+You are in control. Just need to know how!
+
+### Installation
+
+Add `gem "flexirails"` to your `Gemfile`.
+
+### Usage
+
+Now you need two more steps to get going:
+
+1. subclass `::Flexirails::View` or `::Flexirails::ArrayView`.
+
+    ``` ruby
+    class PeopleView < ::Flexirails::View
+      def total
+        Person.count
+      end
+
+      def query offset, limit
+        Person.offset(offset).limit(limit)
+      end
+
+      def columns
+        %w(id name)
+      end
+    end
+    ```
+
+2. instanciate your view class in your controller:
+
+    ``` ruby
+    class PeopleController < ApplicationController
+      protected
+      def people_view
+        @people_view ||= PeopleView.new(params)
+      end
+      helper_method :people_view
+    end
+    ```
+
+3. render appropriate partials in your views:
+
+    ``` erb
+    <%= render :partial => '/flexirails/navigation', :locals => { :view => people_view } %>
+    <%= render_flexirails_view(people_view, { :class => 'statics' }) %>
+    ```
+
+Columns are translated as `<lang>.<view_as_snake_case>.<column>`, e.g. `de.people_view.name`.
+
+### Advanced Usage
+
+You can pass additional informations to your view - e.g. the current user for complex logic
+
+``` ruby
+class PeopleView < ::Flexirails::View
+  attr_reader :current_user, :current_project
+  def initialize params, user, project
+    @current_user = user
+    @current_project = project
+    super params
+  end
+
+  def scoped
+    if current_user.admin?
+      Person.scoped
+    else
+      current_project.people
+    end
+  end
+
+  def total
+    scoped.count
+  end
+
+  def query offset, limit
+    scoped.offset(offset).limit(limit)
+  end
+end
+```
+
+By default attributes are extracted from the current row object. But you can render partials if you want to:
+``` ruby
+class PeopleView < ::Flexirails::View
+  def total
+    Person.count
+  end
+
+  def query offset, limit
+    Person.offset(offset).limit(limit)
+  end
+
+  def columns
+    %w(id name actions)
+  end
+
+  def render_actions person, context
+    context.render :partial => "actions", :locals => { :person => person }
+  end
+end
+```
+
+You can sort your data if you want to. `order` and `direction` are sanitized by default, no need to check.
+``` ruby
+class PeopleView < ::Flexirails::View
+  def query offset, limit
+    scope = if order_query?
+      Person.order("#{order} #{direction}")
+    else
+      Person
+    end
+    scope.offset(offset).limit(limit)
+  end
+
+  def sortable_columns
+    %w(id)
+  end
+end
+```
+
+You can filter your data if you want to:
+``` ruby
+class PeopleView < ::Flexirails::View
+  attr_reader :minimum_id
+  def initialize params
+    @minimum_id = params.fetch(:minimum_id, nil)
+
+    super params
+  end
+
+  def scoped
+    if minimum_id.present?
+      Person.where(["id > ?", minimum_id])
+    else
+      Person.scoped
+    end
+  end
+
+  def total
+    scoped.count
+  end
+
+  def query offset, limit
+    scoped.offset(offset).limit(limit)
+  end
+end
+```
+
+### TODO
+
+- enhance the test suite
+- refactor the small, inlined- js a little. its ugly as hell
+- refactor the css. its ugly as hell as well
+- maybe add a small abstraction for ActiveRecord Views
+
+### Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,39 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+  require "bundler/gem_tasks"
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Flexirails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/stylesheets/flexirails.scss

@@ -0,0 +1,55 @@
+.filter {
+  .row .columns {
+    height: 32px !important;
+    line-height: 32px !important;
+    margin-bottom: 3px;
+  }
+  margin-bottom: 5px;
+}
+
+div.flexirails {
+  overflow: scroll;
+}
+
+nav.flexirails {
+  div {
+    display: inline-block;
+  }
+  input {
+    display: inline-block;
+  }
+  .page {
+    input {
+      width: 50px;
+    }
+  }
+  svg {
+    fill: white;
+  }
+  .pagination a {
+    height: 32px;
+    line-height: 34px;
+    display: inline-block;
+    vertical-align: middle;
+  }
+}
+
+.flexirails table {
+  width: 100%;
+  th {
+    text-align: left;
+  }
+  td {
+    padding: 5px;
+  }
+  td.actions {
+    span {
+      display: inline-block;
+    }
+
+    a {
+      min-width: 32px;
+      min-height: 32px;
+    }
+  }
+}

data/app/helpers/flexirails_helper.rb

@@ -0,0 +1,25 @@
+require 'url_plumber'
+
+module FlexirailsHelper
+  def pagination_first_icon
+    return '<svg version="1.2" baseProfile="tiny" id="Navigation_first" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" width="16px" height="16px" viewBox="0 0 512 512" overflow="inherit" xml:space="preserve"> <path d="M186.178,256.243l211.583,166.934V89.312L186.178,256.243z M112.352,422.512h66.179V89.975h-66.179V422.512z"/> </svg>'
+  end
+  def pagination_prev_icon
+    return '<svg version="1.2" baseProfile="tiny" id="Navigation_left" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" width="16px" height="16px" viewBox="0 0 512 512" overflow="inherit" xml:space="preserve"> <polygon points="148.584,255.516 360.168,88.583 360.166,422.445 "/> </svg>'
+  end
+  def pagination_last_icon
+    return '<svg version="1.2" baseProfile="tiny" id="Navigation_last" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" width="16px" height="16px" viewBox="0 0 512 512" overflow="inherit" xml:space="preserve"> <path d="M111.708,424.514l211.581-166.927L111.708,90.654V424.514z M330.935,87.311v332.544h66.173V87.311H330.935z"/> </svg>'
+  end
+  def pagination_next_icon
+    return '<svg version="1.2" baseProfile="tiny" id="Navigation_right" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" width="16px" height="16px" viewBox="0 0 512 512" overflow="inherit" xml:space="preserve"> <polygon points="360.124,255.513 148.535,422.442 148.537,88.58 "/> </svg>'
+  end
+  def render_flexirails_view view, opts = {}
+    return render partial: '/flexirails/container', locals: { view: view, table_class: opts.fetch(:class) { "" } }
+  end
+  def url_plumb(key, value)
+    url_for(::UrlPlumber::Plumber.new(params).plumb(key => value))
+  end
+  def url_batch_plumb(hash)
+    url_for(::UrlPlumber::Plumber.new(params).plumb(hash))
+  end
+end

data/app/models/flexirails/array_view.rb

@@ -0,0 +1,17 @@
+module Flexirails
+  class ArrayView < ::Flexirails::View
+    attr_reader :items
+    def initialize params, items
+      @items = items
+      super params
+    end
+
+    def query offset, limit
+      items[offset..(offset+limit-1)]
+    end
+
+    def total
+      items.size
+    end
+  end
+end

data/app/models/flexirails/view.rb

@@ -0,0 +1,123 @@
+module Flexirails
+  class View
+    attr_reader :offset, :limit, :current_page, :per_page, :order, :direction, :params
+
+    def initialize params
+      @params = params
+      pagination = params.fetch(:pagination) { params || Hash.new }
+
+      @current_page = pagination.fetch(:current_page) { 1 }.to_i
+      @per_page = pagination.fetch(:per_page) { 25 }.to_i
+      @order = sanitize(pagination.fetch(:order) { nil })
+      @direction = sanitize_direction(pagination.fetch(:direction) { nil })
+
+      if @current_page > total_page_count
+        @current_page = 1
+      end
+
+      @offset = (current_page-1) * per_page
+      @limit = per_page
+    end
+
+    def next_pagination_direction column
+      if order == column
+        if direction == "DESC"
+          nil
+        else
+          if direction == nil
+            "ASC"
+          else
+            "DESC"
+          end
+        end
+      else
+        "ASC"
+      end
+    end
+
+    def total_page_count
+      return (self.total.to_f / self.per_page.to_f).ceil
+    end
+
+    def total
+      raise "ImplementationMissing"
+    end
+
+    def query offset = self.offset, limit = self.limit
+      raise "ImplementationMissing"
+    end
+
+    def has_prev_path
+      return self.current_page > 1
+    end
+    def has_next_path
+      return self.current_page < total_page_count
+    end
+
+    def sortable_columns
+      return %w()
+    end
+
+    def columns
+      sortable_columns
+    end
+
+    def order_query?
+      return order.present? && direction.present?
+    end
+    alias_method :order_results?, :order_query?
+
+    def rows
+      return @rows ||= query(offset, limit)
+    end
+
+    def i18n_scope clazz = self.class
+      return clazz.name.tableize.singularize.gsub('/','.')
+    end
+
+    def i18n_default name
+      scopes = []
+      clazz = self.class
+      clazz.ancestors.each do |ancestor|
+        break if ancestor == Object
+        scopes << [i18n_scope(ancestor),name].compact.join('.').to_sym
+      end
+      return scopes
+    end
+
+    def t name, args = {}
+      I18n.t([i18n_scope,name].compact.join('.'), { default: i18n_default(name) }.merge(args))
+    end
+
+    def render_column column, row, context
+      method_to_call = "render_#{column.gsub(/\./, '_')}"
+      if self.respond_to?(method_to_call.to_sym)
+        return self.send method_to_call.to_sym, row, context
+      else
+        parts = column.split('.').map(&:to_sym)
+        object = row
+        parts.each do |part|
+          object = object.send(part)
+        end
+        return object
+      end
+    end
+
+    def pagination_hash
+      return {
+        current_page: self.current_page,
+        per_page: self.per_page,
+        order: self.order,
+        direction: self.direction
+      }
+    end
+
+    private
+    def sanitize_direction direction
+      return %w(ASC DESC).include?(direction) ? direction : nil
+    end
+    def sanitize attribute
+      return columns.include?(attribute) ? attribute : nil
+    end
+  end
+end