crudle 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b085645d20a6a26aa76a02f06b7ffdeaecbf236d
-  data.tar.gz: e233fac2137bde5dddfd95a81b31c1cdb7b98e3f
+  metadata.gz: 518edfc85e64b5299f952a7985ff74a0e0d09da5
+  data.tar.gz: bc3c58be4766df258be5a65e323049baf70e13a3
 SHA512:
-  metadata.gz: 52a40b6a01a03ad2c45cf1a709883a050fd43a1596e48e82116487ed00afea8e358d6d5953f12485cb3109eb0908c84aeb1396ab08575f6133530e8073dd0c0d
-  data.tar.gz: 5e991bd543f35f82a4f35307a952217094fba3969f1c52527074b67b31d21b8a5a4a4bf5e08b438551cd1362f2ba6fc06aa5fd2a3076a8f55a589d02e6a32a7a
+  metadata.gz: 2afa5a283d9ae520bad351d8b72753428d623fba958367bd3b88f3923fe0bc7ae5c94e7ec4934d750241dc47620ad5d6ba42d9d4bd6f66f26a997fca1f5e41b2
+  data.tar.gz: 561a590e9fe3f83e177dee490483a6c26ee34e25e3ae5fc7f3b487f32e2d89f13591be2e1a363608df2d20aeb1f24f69caa18610eec6fa8a484188cfbe66eaea

data/crudle.gemspec

@@ -1,10 +1,9 @@
 # coding: utf-8
+require File.expand_path('../lib/crudle/version', __FILE__)
 
 Gem::Specification.new do |spec|
-  spec.name, spec.version = %w[
-    crudle
-    0.0.1
-  ]
+  spec.name        = 'crudle'
+  spec.version     = Crudle::VERSION
   spec.authors     = ['Slee Woo']
   spec.email       = ['mail@sleewoo.com']
   spec.summary     = [spec.name, spec.version]*'-',

data/lib/crudle/version.rb

@@ -0,0 +1,3 @@
+module Crudle
+  VERSION = '0.0.3'.freeze
+end

data/lib/crudle.rb

@@ -1,14 +1,188 @@
-require 'crudle/controller_setup'
-require 'crudle/instance_methods'
-
 module Crudle
   NAME_QUERY = 'name ILIKE ?'.freeze
   NAME_QUERY_FORMAT = '%s%%'.freeze
-  FILTER_METHOD_FORMAT = 'filter_by_%s'.freeze
+  FILTER_METHOD_FORMAT = '%s_filter'.freeze
 
   module Controller
     def self.included base
-      base.class_exec(&Crudle::ControllerSetup)
+      base.class_exec do
+
+        def init params
+          {}
+        end
+
+
+        def list params = {}
+          dataset       = filtered_dataset(params)
+          offset, pager = pager(params, dataset.count, items_per_page, side_pages)
+          {
+            items: fetch_items(dataset, offset, params[:id]).map {|i| {self: list_serializer(i)}},
+            pager: pager
+          }
+        end
+
+
+        def list_item item_id
+          list_serializer(find_item(item_id))
+        end
+
+
+        def create
+          model.create.id
+        end
+
+
+        def retrieve id
+          editor_serializer(find_item(id))
+        end
+
+
+        def update id, data
+          item = find_item(id)
+          data.each_pair {|k,v| item[k] = v}
+          item.valid? || halt(400, error: item.errors.each_with_object([]) {|e,o| o << e.join(': ')})
+          item.save
+          editor_serializer(item)
+        end
+
+
+        def delete id, params
+          find_item(id).destroy
+          list(params)
+        end
+
+
+        def delete_selected selected, params
+          model.where(id: selected).map(&:destroy)
+          list(params)
+        end
+
+
+        private
+
+        def find_item id
+          model.find_by(id: id) || halt(400, 'No item found by given ID: #%s' % escape_html(id.to_s))
+        end
+
+
+        def model
+          raise('Model not set. Please define a #model method that returns your model')
+        end
+
+
+        def items_per_page
+          25
+        end
+
+
+        def side_pages
+          4
+        end
+
+
+        def order
+          nil
+        end
+
+
+        def list_serializer item
+          serializer(item)
+        end
+
+
+        def editor_serializer item
+          serializer(item)
+        end
+
+
+        def serializer item
+          item
+        end
+
+
+        def filter params, dataset
+          return if params[:q].nil? || params[:q].empty?
+          if id = params[:q].scan(/id=(\d+)/).flatten[0]
+            return dataset.where(id: id)
+          end
+          dataset.where(Crudle::NAME_QUERY, Crudle::NAME_QUERY_FORMAT % params[:q])
+        end
+
+
+        def filtered_dataset params
+          filters = private_methods
+          params = indifferent_params(params)
+          params.inject(filter(params, model) || model) do |dataset,(k,v)|
+            filter_method = Crudle::FILTER_METHOD_FORMAT % k
+            if filters.include?(filter_method.to_sym)
+              send(filter_method, params, dataset) || dataset
+            else
+              dataset
+            end
+          end
+        end
+
+
+        def fetch_items dataset, offset, id = nil
+
+          items = if order = order()
+            model.unscoped do
+              dataset.order(order).offset(offset).limit(items_per_page).to_a
+            end
+          else
+            dataset.offset(offset).limit(items_per_page).to_a
+          end
+
+          if id
+            id = id.to_i
+            if !items.find {|i| i.id == id} && item = model.find_by(id: id)
+              items.delete_if {|i| i.id == item.id}
+              items.unshift(item)
+            end
+          end
+
+          items
+        end
+
+
+        def pager params, total_items, items_per_page, side_pages
+          total_pages = (total_items.to_f / items_per_page.to_f).ceil
+
+          current_page = params[:p].to_i
+          current_page = 1 if current_page < 1
+          current_page = total_pages if current_page > total_pages
+
+          next_page = current_page + 1
+          next_page = nil if next_page > total_pages
+          prev_page = current_page - 1
+          prev_page = nil if prev_page < 1
+
+          min_page = current_page  - side_pages
+          min_page = total_pages   - (side_pages * 2) if (current_page + side_pages) > total_pages
+          min_page = 1 if min_page < 1
+
+          max_page = current_page + side_pages
+          max_page = side_pages   * 2 if current_page < side_pages
+          max_page = total_pages  if max_page > total_pages
+
+          offset = (current_page - 1) * items_per_page
+          offset = 0 if offset < 0
+
+          counter = {a: offset + 1, z: offset + items_per_page, total: total_items}
+          counter[:a] = offset if counter[:a] > total_items
+          counter[:z] = total_items if counter[:z] > total_items
+
+          [offset, {
+            current_page: current_page,
+             total_pages: total_pages,
+               next_page: next_page,
+               prev_page: prev_page,
+              pages_list: (min_page .. max_page).to_a,
+                 counter: counter
+          }]
+        end
+
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crudle
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Slee Woo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-25 00:00:00.000000000 Z
+date: 2016-05-23 00:00:00.000000000 Z
 dependencies: []
 description: Building blocks for opinionated CRUD interfaces
 email:
@@ -22,8 +22,7 @@ files:
 - Rakefile
 - crudle.gemspec
 - lib/crudle.rb
-- lib/crudle/controller_setup.rb
-- lib/crudle/instance_methods.rb
+- lib/crudle/version.rb
 homepage: https://github.com/crudle/ruby-server
 licenses:
 - MIT
@@ -47,5 +46,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: '["crudle-0.0.1", "Building blocks for opinionated CRUD interfaces"]'
+summary: '["crudle-0.0.3", "Building blocks for opinionated CRUD interfaces"]'
 test_files: []

data/lib/crudle/controller_setup.rb

@@ -1,44 +0,0 @@
-module Crudle
-  ControllerSetup = -> do
-    include Crudle::InstanceMethods
-
-    def list params = {}
-      dataset       = filtered_dataset(params)
-      offset, pager = pager(params, dataset.count, items_per_page, side_pages)
-      {
-        items: fetch_items(dataset, offset, params[:id]).map {|i| list_serializer(i)},
-        pager: pager
-      }
-    end
-
-
-    def load id
-      editor_serializer(find_item(id))
-    end
-
-
-    def create
-      model.create.id
-    end
-
-
-    def save id, data
-      item = find_item(id)
-      data.each_pair {|k,v| item[k] = v}
-      item.valid? || halt(400, error: item.errors.each_with_object([]) {|e,o| o << e.join(': ')})
-      item.save
-      list_serializer(item)
-    end
-
-
-    def delete id
-      find_item(id).destroy
-    end
-
-
-    def delete_selected params, selected
-      model.where(id: selected).map(&:destroy)
-      list(params)
-    end
-  end
-end

data/lib/crudle/instance_methods.rb

@@ -1,115 +0,0 @@
-module Crudle
-  module InstanceMethods
-
-    private
-    def find_item id
-      model.find_by(id: id) || halt(400, 'No item found with ID #%s' % escape_html(id.to_s))
-    end
-
-
-    def model
-      raise('Model not set. Please define a #model method that returns your model')
-    end
-
-
-    def items_per_page
-      25
-    end
-
-
-    def side_pages
-      4
-    end
-
-
-    def order
-      {id: :desc}
-    end
-
-
-    def list_serializer item
-      serializer(item)
-    end
-
-
-    def editor_serializer item
-      serializer(item)
-    end
-
-
-    def serializer item
-      item
-    end
-
-
-    def filter params, dataset
-      return if params[:q].nil? || params[:q].empty?
-      if id = params[:q].scan(/id=(\d+)/).flatten[0]
-        return dataset.where(id: id)
-      end
-      dataset.where(Crudle::NAME_QUERY, Crudle::NAME_QUERY_FORMAT % params[:q])
-    end
-
-
-    def filtered_dataset params
-      params.inject(filter(params, model) || model) do |dataset,(k,v)|
-        filter_method = Crudle::FILTER_METHOD_FORMAT % k
-        if respond_to?(filter_method)
-          send(filter_method, params, dataset) || dataset
-        else
-          dataset
-        end
-      end
-    end
-
-
-    def fetch_items dataset, offset, id = nil
-      items = model.unscoped do
-        dataset.order(order).offset(offset).limit(items_per_page).to_a
-      end
-      if id && item = model.find_by(id: id)
-        items.delete_if {|i| i.id == item.id}
-        items.unshift(item)
-      end
-      items
-    end
-
-
-    def pager params, total_items, items_per_page, side_pages
-      total_pages = (total_items.to_f / items_per_page.to_f).ceil
-
-      current_page = params[:p].to_i
-      current_page = 1 if current_page < 1
-      current_page = total_pages if current_page > total_pages
-
-      next_page = current_page + 1
-      next_page = nil if next_page > total_pages
-      prev_page = current_page - 1
-      prev_page = nil if prev_page < 1
-
-      min_page = current_page  - side_pages
-      min_page = total_pages   - (side_pages * 2) if (current_page + side_pages) > total_pages
-      min_page = 1 if min_page < 1
-
-      max_page = current_page + side_pages
-      max_page = side_pages   * 2 if current_page < side_pages
-      max_page = total_pages  if max_page > total_pages
-
-      offset = (current_page - 1) * items_per_page
-      offset = 0 if offset < 0
-
-      counter = {a: offset + 1, z: offset + items_per_page, total: total_items}
-      counter[:a] = offset if counter[:a] > total_items
-      counter[:z] = total_items if counter[:z] > total_items
-
-      [offset, {
-        current_page: current_page,
-         total_pages: total_pages,
-           next_page: next_page,
-           prev_page: prev_page,
-          pages_list: (min_page .. max_page).to_a,
-             counter: counter
-      }]
-    end
-  end
-end