rooble 0.0.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a4d2cb17f6bb39efab61bf9505f07d7b244d454
-  data.tar.gz: e60dfd9da1704718c8d4d01ee0a57764ccc13456
+  metadata.gz: a5337c75a8c00119f11ac79c63831303bd404a2c
+  data.tar.gz: ffc83ab5fd996a9b11d484cb3833e4ff136d26c0
 SHA512:
-  metadata.gz: ca3dae8f9ad5039ca86ded8c6731013b30162f0492d659633cbcf716f6dbefaffda55ceecdd2b88e3ba280525eb079ac623ccfca7867fd65f3063bec1da96ada
-  data.tar.gz: f5ab1bc4338214d6750bc922bce0bb0d1b59e4b3d3fd29a71408774fb721f204605f37a27ec427d449fad0958227010667cd229eda29ca2ac6b0bbcc70e3ea08
+  metadata.gz: 980c19cf41833ed5d3011953337ddad9d88b9f71944d71a8470ea81502a46944b04e143cb22984503c91cb1415b0f0fd06593d9b24be8929fc671bbfb6744829
+  data.tar.gz: b29f881f359c49f37fbf97b9f6830f50a398303b2652a474ba47bcc9d853fffc4b1e35f35188902b91b2107830145619560da5e3aedb2c4f3c4d0e12c0030f91

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Gustavo Rubio
+
+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,56 @@
+# rooble
+
+Yet another unnecessary and selfishly-created pagination and search gem for rails.
+
+## Why?
+
+Because its a fun way for me to learn rails. There are other, more complex and full featured solutions like [Kaminari](https://github.com/amatsuda/kaminari) but this works fine too.
+
+## How?
+
+Add this to your Gemfile:
+
+`gem 'rooble'`
+
+Then do the usual dance:
+
+`bundle install`
+
+## Using it
+
+First create a configuration file by running `rails g rooble:config` which will create `config/initializers/rooble.rb` and setup the default value for `max_records_per_page` to a sane number, you don't want to make it a high number.
+
+There are three main methods:
+
+`Model.pages` without any parameters will give you the number of available pages considering the `max_records_per_page` default. You can override it and pass the number of max records that should be counted per page so you get the total count of pages for such number doing something like `Model.pages(10)` if you want the count of pages with 10 records per page.
+
+`Model.paginate(1)` will give you records for the first page. You can override the `max_records_per_page` config option on the second argument so that you paginate a specific page with a different amount of max records, for instance `Model.paginate(1, 10)` would grab the 10 records for the 1st page.
+
+`Model.search("John", [:name])` will look for records which have **John** within the `name` attribute.
+
+There is an extra options hash that you can pass to this method, the options are:
+
+ * `case_sensitive: false` whether you want to make the search case sensitive. Default is false.
+ * `type: all` type of match, beginning, end or the whole string. Default is all.
+ * `include` an array/hash of symbols if you want to include other relations on the model. Same as with default rails include.
+ * `join` an array/hash of symbols if you want to join other relations on the model. Same as with default rails join.
+
+If you want to search for attributes in joint models you would do something like this:
+
+`State.search("USA", "countries.name", join: [:country]).first`
+
+Or if you want to search for the first city of the USA:
+
+`City.search("USA", "countries.name", join: {state: :country}).first`
+
+That would search the first state that has a country named USA. Do note the string notation for the relation.
+
+Oh yes, you can chain the methods so you could do something like paginating search results:
+
+`State.search("USA", "countries.name", join: [:country]).paginate(2)`
+
+That's it for now.
+
+## Other features
+
+I will/may add a view helper to generate the pagination navigation and and initializer for the `MAX_RECORDS_PER_PAGE`. For now just set it yourself on your env vars.

data/lib/generators/rooble/config_generator.rb

@@ -0,0 +1,12 @@
+module Rooble
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+      desc "Creates the initializer for Rooble"
+
+      def copy_initializer
+        template 'config_initializer.rb', 'config/initializers/rooble.rb'
+      end
+    end
+  end
+end

data/lib/generators/templates/config_initializer.rb

@@ -0,0 +1,4 @@
+# Set here all of the pagination configuration
+Rooble.configure do |config|
+  config.max_records_per_page = 5
+end

data/lib/rooble.rb

@@ -1,6 +1,25 @@
+require "rooble/version"
+
+# Main module for rooble.
 module Rooble
   extend ActiveSupport::Concern
 
+  class Configuration
+    attr_accessor :max_records_per_page
+  end
+
+  class Error < StandardError
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration) if block_given?
+  end
+
   def self.build_query(search_term, fields, options={})
 
     # Set whether we want case sensitive search
@@ -35,41 +54,47 @@ module Rooble
   end
 
   module ClassMethods
-    def pages
-      max_records_per_page = ENV['MAX_RECORDS_PER_PAGE'].to_i
+    ##
+    # Returns the amount of available pages to do pagination.
+    #
+
+    def pages(max_records_per_page=nil)
+      max_records_per_page ||= Rooble::configuration.max_records_per_page
       total_record_count = self.count
       return 0 unless total_record_count > 0
       pages = (total_record_count.to_f / max_records_per_page.to_f).ceil
     end
 
-    def paginate(page=1)
+    ##
+    # Returns a set of paginated records given a page.
+    #
+
+    def paginate(page=1, max_records_per_page=nil)
       page ||= 1
 
       if page.to_i < 0
-        raise StandardError.new "Pagination index must be greater than zero"
+        raise Rooble::Error.new "Pagination index must be greater than zero"
       end
 
-      max_records_per_page = ENV['MAX_RECORDS_PER_PAGE'].to_i
+      max_records_per_page ||= Rooble::configuration.max_records_per_page
       current_offset = ((page.to_i*max_records_per_page))-max_records_per_page
       records = self.limit(max_records_per_page).offset(current_offset)
     end
 
-    def search(search_term, fields, options={})
-      # Options:
-      # case_sensitive: true or false, default is false
-      # type: beginning, end, all. whether to match beginning of the field, end or the whole thing (defauult is all)
-      # include: an array of symbols with relations to include
-      # join: an array of symbols with relations to join
+    ##
+    # Searches through records for the given fields
+    #
 
+    def search(search_term, fields, options={})
       if search_term.nil?
         raise StandardError.new "You need to give a search term"
       end
 
       if fields.empty?
-        raise StandardError.new "You need to give at least one field to search"
+        raise Rooble::Error.new "You need to give at least one field to search"
       end
 
-      raise StandardError.new("You can only include or join relations, not both!") if ([:include, :join] - options.keys ).empty?
+      raise Rooble::Error.new("You can only include or join relations, not both!") if ([:include, :join] - options.keys ).empty?
 
       # Build the query
       query = Rooble::build_query(search_term, fields, options)

data/lib/rooble/version.rb

@@ -0,0 +1,3 @@
+module Rooble
+  VERSION = "0.1.2"
+end

data/rooble.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rooble/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'rooble'
+  spec.version     = Rooble::VERSION
+  spec.authors     = ["Gustavo Rubio"]
+  spec.email       = 'gus@ahivamos.net'
+
+  spec.summary     = "Allows to paginate and search through ActiveRecord associations in rails."
+  spec.description = "Yet another unnecessary and selfishly-created pagination and search gem for rails. This gem will add methods to your ActiveRecord associations and classes so you can search and paginate."
+  spec.homepage    = 'http://github.com/gusrub/rooble'
+  spec.license     = 'MIT'
+  spec.date        = Date.today.to_s
+  spec.require_paths = ["lib"]
+  spec.files       = `git ls-files`.split("\n")
+  spec.platform    = Gem::Platform::RUBY
+  spec.post_install_message = "Here, have a cookie for installing this wonderful gem: 🍪"
+
+  spec.add_dependency 'activesupport', '~> 4.0', '>= 4.0.0'
+  spec.add_dependency 'activerecord', '~> 4.0', '>= 4.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.0', '>= 1.0.0'
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rooble
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Gustavo Rubio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-05 00:00:00.000000000 Z
+date: 2016-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,6 +30,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -50,18 +70,41 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
-description: Allows to paginate and search through ActiveRecord associations
+- !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'
+description: Yet another unnecessary and selfishly-created pagination and search gem
+  for rails. This gem will add methods to your ActiveRecord associations and classes
+  so you can search and paginate.
 email: gus@ahivamos.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- LICENSE
+- README.md
+- lib/generators/rooble/config_generator.rb
+- lib/generators/templates/config_initializer.rb
 - lib/rooble.rb
+- lib/rooble/version.rb
+- rooble.gemspec
 homepage: http://github.com/gusrub/rooble
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: "Here, have a cookie for installing this wonderful gem: \U0001F36A"
 rdoc_options: []
 require_paths:
 - lib
@@ -80,6 +123,5 @@ rubyforge_project:
 rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: Yet another unnecessary and selfishly-created pagination and search gem for
-  rails
+summary: Allows to paginate and search through ActiveRecord associations in rails.
 test_files: []