r_kit 0.4.2 → 0.4.3

data/lib/r_kit/pagination/base.rb

@@ -0,0 +1,153 @@
+class RKit::Pagination::Base < SimpleDelegator
+
+  # TODO: use collection delegator newly done in 'strcut'
+
+  alias :collection :__getobj__
+  alias :collection= :__setobj__
+
+  attr_accessor :page, :per_page
+
+  # TODO: should raise an error if has "limit" or "offset" values
+  def initialize collection, **options
+    raise if collection.values.keys.include_one? [:limit, :offset]
+
+    super collection
+
+    @page = options.fetch :page, 1
+    @per_page = options.fetch :per_page, RKit::Pagination.config.per_page[collection.klass]
+  end
+
+  def method_missing method_name, *args, &block
+    closure = super
+
+    case closure
+    when collection.class
+      self.collection = closure
+      self
+    else
+      closure
+    end
+  end
+
+  tap_attr_accessor :page
+  tap_attr_accessor :per_page
+
+  def total_pages
+    (collection.count / per_page.to_f).ceil
+  end
+
+
+  # TODO: limit & offset should raise a custom made error
+  def limit
+    raise
+  end
+
+  def offset
+    raise
+  end
+
+
+  include Enumerable
+
+  def limited_collection
+    collection
+      .limit(per_page)
+      .offset((page-1) * per_page)
+  end
+
+  def each &block
+    limited_collection.each &block
+  end
+
+  delegate :inspect, to: :limited_collection
+
+
+
+  def pages
+    (1..total_pages).map do |page|
+      RKit::Pagination::Base::Page.new self, page: page
+    end
+  end
+
+  def previous_page
+    pages.find{ |page| page.page == (self.page - 1) } || pages.first
+  end
+
+  def next_page
+    pages.find{ |page| page.page == (self.page + 1) } || pages.last
+  end
+
+
+
+  extend RKit::Decoration::ActiveRecordExtend
+  acts_as_decorables do
+
+    include Enumerable
+
+    def each &block
+      limited_collection.decorate.each &block
+    end
+
+
+    def pagination_tag
+      view.content_tag :nav, class: :pagination do
+        [previous_page_tag, pages_tag, next_page_tag].reduce(:safe_concat)
+      end
+    end
+
+    def previous_page_tag
+      previous_page.decorate.page_tag "<"
+    end
+
+    def pages_tag
+      pages.map(&:decorate).map(&:page_tag).reduce(:safe_concat)
+    end
+
+    def next_page_tag
+      next_page.decorate.page_tag ">"
+    end
+  end
+
+
+
+
+  # TODO: limited_collection, total_pages & pages can change, based on scopes or "page & per_page" config
+  # So we need a "@loaded" instance_variable
+  # that will have the same role as in AR::Relation
+  # -> either, can't scope if loaded
+  # -> either, empty the 3 "based on scope/config" variables
+  # --
+  # or, we don't memoize the 3 problematic vars
+  # wich will be my choice right now
+
+
+
+
+  # I need
+  # collection, records/instances/results/paginated_collection/limited_collection(as we use SQL 'limit')
+  # current page, total nb items, total pages
+
+  # calling could be : Articles.paginate(page: 2, per_page: 15).published
+  # note that published is _after_, but we still want to display 15 records
+  # Alternative call Articles.paginate.page(2).per_page(15)
+  # --
+  # the "per_page" will be settable either by an arg in the method,
+  # or by an option, per model, in the dsl (access by Article.all.instance_variable_get "@klass")
+  # or in the "pagination" config
+  # the "current page" will be 1 by default
+
+  # Raise an error if the collection has a "limit" or an "offset" (before or after pagination initialization)
+  # here is the pagination method scope : Paginator::Collection.new(scoped).limit(per).offset((page-1) * per)
+
+
+  # We also need a method "pagination_tag", in the view
+  # maybe use a decorator to do so.
+
+  # Define an option to use pagination based on instance, in this case, the "per_page" is set to one
+  # and the "pagination_tag" accept a block to display the "page number"
+
+
+  # Idea, the "current_page" info (to disable the current page link) could be an instance of a class (pagination::Page)
+  # so in that class, (or in her decorator), we could define the "link_to_page" method
+  # (and the "disabled_link_to", wich we will alias on self)
+end

data/lib/r_kit/pagination.rb

@@ -0,0 +1,23 @@
+class RKit::Pagination
+
+  dependency :decoration
+  dependency :utility
+
+
+  load_path __FILE__, 'base.rb'
+  load_path __FILE__, 'base/page.rb'
+
+  load_path __FILE__, 'active_record_extend.rb'
+
+  # TODO: add a "wrap" option to the config method, that will be used like this
+  # config :per_page, 16, wrap: ->(value){ Hash.new(value) }
+  # in this case: this allow the user to only set a default number
+  # but we, in the code, need a hash with that default value
+  # so, in our use, the value "16" will be wrapped in a hash, as the default value of this hash
+  # and to the user, he only see a default "per_page" number. (he does not want to know that we use a hash in fact)
+  # --
+  # To do this, I think that we will need a serious rework of the "configurer" core class
+  # and consider each config value to be an instance of a "config_value" class (under the configurer namespace)
+  # (we did it once for "loader", we can do it again!)
+  config :per_page, Hash.new(16)
+end

data/lib/r_kit/struct/collection_delegator.rb

@@ -0,0 +1,24 @@
+class CollectionDelegator < SimpleDelegator
+
+  alias :collection :__getobj__
+  alias :collection= :__setobj__
+
+  def method_missing method_name, *args, &block
+    closure = super
+
+    case closure
+    when collection.class
+      self.collection = closure
+      self
+    else
+      closure
+    end
+  end
+
+
+  include Enumerable
+
+  def each &block
+    collection.each &block
+  end
+end

data/lib/r_kit/struct/safe_struct.rb

@@ -0,0 +1,35 @@
+class SafeStruct
+
+  def self.new allowed:, defaults: {}
+    Class.new do
+      @allowed = allowed.map(&:ivar)
+      @defaults = defaults
+
+      def self.allowed() @allowed end
+      def self.defaults() @defaults end
+
+
+      attr_reader *allowed, default: proc{ |_, name| defaults[name] }
+      attr_writer *allowed
+
+      def initialize **options
+        options.keys.each do |name|
+          instance_variable_set "@#{ name }", options[name]
+        end
+      end
+
+      def instance_variable_set name, value
+        super if __class__.allowed.include? name
+      end
+
+
+      def to_hash
+        instance_variables.reduce({}) do |options, name|
+          options[name.lvar] = instance_variable_get name
+          options
+        end
+      end
+    end
+  end
+
+end

data/lib/r_kit/struct/strong_struct.rb

@@ -0,0 +1,17 @@
+class StrongStruct < SafeStruct
+
+  def self.new allowed:, defaults: {}
+    super.tap do |klass|
+
+      klass.send :define_method, :instance_variable_set, ->(name, value) do
+        if __class__.allowed.include? name
+          super(name, value)
+        else
+          raise NameError.new("unsafe key `#{ name }' for #{ __class__ }")
+        end
+      end
+
+    end
+  end
+
+end

data/lib/r_kit/struct.rb

@@ -0,0 +1,8 @@
+class RKit::Struct
+
+  dependency :utility
+
+  load_path __FILE__, 'safe_struct.rb'
+  load_path __FILE__, 'strong_struct.rb'
+
+end

data/lib/r_kit/utility/active_record_extend.rb

@@ -0,0 +1,7 @@
+module ActiveRecord::ModelSchema::ClassMethods
+
+  def column_exists? column_name
+    !!columns_hash[column_name]
+  end
+
+end

data/lib/r_kit/utility/array_extend.rb

@@ -1,7 +1,16 @@
 class Array
 
   def include_all? values
-    (self & Array(values)).size == size
+    (self & Array(values)).size == Array(values).size
+  end
+
+  def include_one? values
+    (self & Array(values)).size > 0
+  end
+
+
+  def rotate_left
+    push shift
   end
 
 end

data/lib/r_kit/utility/module_extend.rb

@@ -0,0 +1,43 @@
+class Module
+
+  delegate :underscore, :demodulize,
+    to: :name
+
+
+  alias :basic_attr_reader :attr_reader
+  def attr_reader *names, default: nil
+    if default
+      names.each do |name|
+        define_method name do
+          instance_variable_get("@#{ name }") ||
+            instance_variable_set("@#{ name }", default.is_a?(Proc) ? default.call(self, name) : default)
+        end
+      end
+    else
+      basic_attr_reader *names
+    end
+  end
+
+
+  # TODO: these writter are called like ".name(value)" to set and return self
+  # or like ".name" to read
+  # TODO: to be used in 'pagination', these need an "after" callback (to set @limited_collection to nil)
+  # TODO: and to be used in 'grid (base.rb, binding_accessor)', these need an "to" delegation object
+  def tap_attr_accessor *names
+    names.each do |name|
+      define_method name, ->(value = nil) do
+        if value
+          instance_variable_set "@#{ name }", value
+          self
+        else
+          instance_variable_get "@#{ name }"
+        end
+      end
+    end
+  end
+
+
+  def singleton_attr_reader *args, **options
+    singleton_class.send :attr_reader, *args, **options
+  end
+end

data/lib/r_kit/utility/object_extend.rb

@@ -0,0 +1,33 @@
+class Object
+
+  # TODO: I do not know is this is a good idea or a terrible idea
+  # But in either cases, the method names are probably bad, cause too generic (I know it's the hole point)
+  # And may collapse with subclasses
+
+  # TODO: And btw, it is not even used in rkit, as it doens not fullfiled our needs
+
+  # TODO: return self if statement (or block), else, return "value"
+  def fetch statement = nil, value = nil, &block
+    state(statement, &block) ? self : value
+  end
+
+  def reverse_fetch statement = nil, value = nil, &block
+    !state(statement, &block) ? self : value
+  end
+
+  def state statement = nil, &block
+    if statement
+      case self
+      when statement
+        true
+      else
+        false
+      end
+    elsif block_given?
+      !!block.call(self)
+    else
+      raise ArgumentError, 'Must send either "statement" or "&block" argument.'
+    end
+  end
+
+end

data/lib/r_kit/utility/proc_extend.rb

@@ -0,0 +1,41 @@
+class Proc
+
+  def extract_parameters *args, **options, &block
+    before_rest = true
+
+    parameters.reduce({}) do |params, (type, name)|
+      value = case type
+      when :opt
+        # TODO: default_value? -> this will be set to nil, must define a warning, or raise an error
+        # TODO: this is a problem with declaration like: (arg1, arg2 = nil, *args, arg4)
+        # we can do smthng like:
+        # first proccess 'block'
+        # then process 'options'
+        # then process 'args'
+        # -> first process all req at the begining
+        # -> then process all req at the end
+        # -> then process all opt at the begining
+        # -> then process rest
+        # TODO: or, find thehow to access the default value
+        before_rest ? args.shift : args.pop
+      when :req
+        before_rest ? args.shift : args.pop
+      when :rest
+        before_rest = false
+        args
+      when :key
+        options.delete name # TODO: default_value? -> this will be set to nil
+      when :keyreq
+        options.delete name
+      when :keyrest
+        options
+      when :block
+        block
+      end
+
+      params[name] = value
+      params
+    end
+  end
+
+end

data/lib/r_kit/utility/simple_delegator_extend.rb

@@ -0,0 +1,12 @@
+class SimpleDelegator
+
+  # TODO: get some methods from decorator, like "class", "==="
+  # TODO: and add some custom like "inspect"
+
+  def self.getobj_attr_reader *names
+    names.each do |name|
+      define_method name, ->(){ __getobj__.instance_variable_get(name.ivar) }
+    end
+  end
+
+end

data/lib/r_kit/utility/string_extend.rb

@@ -0,0 +1,20 @@
+class String
+
+  def to_boolean
+    !!(self =~ /^(true|t|yes|y|1)$/i)
+  end
+
+
+  def ivar
+    "@#{ self }"
+  end
+
+  def lvar
+    if self =~ /^@/
+      self[1..-1]
+    else
+      self
+    end
+  end
+
+end

data/lib/r_kit/utility/symbol_extend.rb

@@ -1,3 +1,3 @@
 class Symbol
-  delegate :classify, to: :to_s
+  delegate :classify, :ivar, :lvar, to: :to_s
 end

data/lib/r_kit/utility.rb

@@ -1,5 +1,8 @@
 class RKit::Utility
-  UTILITIES = %i{array hash kernel symbol}
+  # TODO: this 'dir' line could be a utility extend
+  UTILITIES = Dir[File.join(File.dirname(__FILE__), "utility", "*.rb")].map do |file|
+    File.basename file, "_extend.rb"
+  end
 
 
   config :extends, true

data/lib/r_kit/version.rb

@@ -1,3 +1,3 @@
 module RKit
-  VERSION = '0.4.2'
+  VERSION = '0.4.3'
 end

data/lib/r_kit.rb

@@ -6,7 +6,16 @@ module RKit
     # some kind of "--help" of unix commands
   end
 
+  delegate :loaded, to: 'RKit::Core::Loader'
 
+
+  # TODO: add a load priority order based on dependencies
+  # so if :X depend on :Y
+  # and I load like ".load :x, :y"
+  # it does not trigger the warn msg of dependency cause we first try to load :x, and :y is still not loaded
+  # instead, we detect that dependencie, and reorder the loading (so we just "require the core descriptive file")
+  # to put :y before :x
+  # (double profit, this will keep config on :y, that iserwise would be lost)
   def load *services
     load_service_from Array.wrap(services)
   end

data/r_kit.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |gem|
   gem.authors       = ["Thomas Petrachi"]
   gem.email         = ["thomas.petrachi@vodeclic.com"]
   gem.description   = %q{Rails tools box}
-  gem.summary       = %q{Rails tools box : Core extentions, Pagination, Decorator, CSS, Javascript, and others comming. A flexible gem that hold a number of basics services for rails applications.}
+  gem.summary       = %q{Rails tools box : Core extentions, Pagination, Decoration, CSS, Javascript, and others comming. A flexible gem that hold a number of basics services for rails applications.}
   gem.homepage      = "https://github.com/petrachi/r_kit"
   gem.license       = 'MIT'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: r_kit
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Thomas Petrachi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-17 00:00:00.000000000 Z
+date: 2014-10-03 00:00:00.000000000 Z
 dependencies: []
 description: Rails tools box
 email:
@@ -25,15 +25,20 @@ files:
 - lib/r_kit.rb
 - lib/r_kit/active_record_utility.rb
 - lib/r_kit/active_record_utility/active_record_extend.rb
+- lib/r_kit/active_record_utility/base.rb
+- lib/r_kit/active_record_utility/base/pool.rb
+- lib/r_kit/active_record_utility/base/publisher.rb
+- lib/r_kit/active_record_utility/base/series.rb
+- lib/r_kit/active_record_utility/base/tag.rb
 - lib/r_kit/active_record_utility/database_schema_error.rb
-- lib/r_kit/active_record_utility/utility.rb
-- lib/r_kit/active_record_utility/utility/tag.rb
 - lib/r_kit/backtrace.rb
 - lib/r_kit/backtrace/kernel_extend.rb
 - lib/r_kit/core.rb
 - lib/r_kit/core/configurer.rb
 - lib/r_kit/core/engineer.rb
 - lib/r_kit/core/loader.rb
+- lib/r_kit/core/loader/dependency.rb
+- lib/r_kit/core/loader/load_path.rb
 - lib/r_kit/css.rb
 - lib/r_kit/css/lib/assets/stylesheets/r_kit.scss
 - lib/r_kit/css/lib/assets/stylesheets/r_kit/base.scss
@@ -47,6 +52,7 @@ files:
 - lib/r_kit/css/lib/assets/stylesheets/r_kit/base/typography/titles.scss
 - lib/r_kit/css/lib/assets/stylesheets/r_kit/components.scss
 - lib/r_kit/css/lib/assets/stylesheets/r_kit/components/btn.scss
+- lib/r_kit/css/lib/assets/stylesheets/r_kit/components/pagination.scss
 - lib/r_kit/css/lib/assets/stylesheets/r_kit/mixins.scss
 - lib/r_kit/css/lib/assets/stylesheets/r_kit/mixins/animation.scss
 - lib/r_kit/css/lib/assets/stylesheets/r_kit/mixins/box-shadows.scss
@@ -58,10 +64,22 @@ files:
 - lib/r_kit/css/lib/assets/stylesheets/r_kit/variables.scss
 - lib/r_kit/css/lib/assets/stylesheets/r_kit/variables/colors.scss
 - lib/r_kit/css/sass_extend.rb
-- lib/r_kit/decorator.rb
-- lib/r_kit/decorator/action_view_base_extend.rb
-- lib/r_kit/decorator/active_record_extend.rb
-- lib/r_kit/decorator/base.rb
+- lib/r_kit/decoration.rb
+- lib/r_kit/decoration/action_view_base_extend.rb
+- lib/r_kit/decoration/active_record_extend.rb
+- lib/r_kit/decoration/base.rb
+- lib/r_kit/decoration/class.rb
+- lib/r_kit/dsl.rb
+- lib/r_kit/dsl/base.rb
+- lib/r_kit/dsl/base/local_params.rb
+- lib/r_kit/dsl/base/params.rb
+- lib/r_kit/dsl/base/readonly.rb
+- lib/r_kit/dsl/base/thrust.rb
+- lib/r_kit/dsl/dsl_definition_error.rb
+- lib/r_kit/dsl/dsl_extend.rb
+- lib/r_kit/dsl/dsl_standard_error.rb
+- lib/r_kit/dsl/module_extend.rb
+- lib/r_kit/dsl/no_lambda_error.rb
 - lib/r_kit/grid.rb
 - lib/r_kit/grid/base.rb
 - lib/r_kit/grid/base/grid.rb
@@ -75,10 +93,24 @@ files:
 - lib/r_kit/grid/lib/assets/stylesheets/r_kit/mixins/gris.scss
 - lib/r_kit/grid/lib/assets/stylesheets/r_kit/variables/grid.scss
 - lib/r_kit/grid/sass_extend.rb
+- lib/r_kit/pagination.rb
+- lib/r_kit/pagination/active_record_extend.rb
+- lib/r_kit/pagination/base.rb
+- lib/r_kit/pagination/base/page.rb
+- lib/r_kit/struct.rb
+- lib/r_kit/struct/collection_delegator.rb
+- lib/r_kit/struct/safe_struct.rb
+- lib/r_kit/struct/strong_struct.rb
 - lib/r_kit/utility.rb
+- lib/r_kit/utility/active_record_extend.rb
 - lib/r_kit/utility/array_extend.rb
 - lib/r_kit/utility/hash_extend.rb
 - lib/r_kit/utility/kernel_extend.rb
+- lib/r_kit/utility/module_extend.rb
+- lib/r_kit/utility/object_extend.rb
+- lib/r_kit/utility/proc_extend.rb
+- lib/r_kit/utility/simple_delegator_extend.rb
+- lib/r_kit/utility/string_extend.rb
 - lib/r_kit/utility/symbol_extend.rb
 - lib/r_kit/version.rb
 - r_kit.gemspec
@@ -105,7 +137,7 @@ rubyforge_project:
 rubygems_version: 2.3.0
 signing_key: 
 specification_version: 4
-summary: 'Rails tools box : Core extentions, Pagination, Decorator, CSS, Javascript,
+summary: 'Rails tools box : Core extentions, Pagination, Decoration, CSS, Javascript,
   and others comming. A flexible gem that hold a number of basics services for rails
   applications.'
 test_files: []

data/lib/r_kit/active_record_utility/utility/tag.rb

@@ -1,14 +0,0 @@
-class RKit::ActiveRecordUtility::Utility::Tag < RKit::ActiveRecordUtility::Utility
-
-  def can_interfere?
-    base.table_exists? && base.column_names.include?("tag")
-  end
-
-  def interfere!
-    base.validates_presence_of :tag
-    base.validates_uniqueness_of :tag
-
-    base.send :define_method, :to_param, ->{ tag }
-    base.send :define_singleton_method, :tagged, ->(tag){ find_by tag: tag }
-  end
-end

data/lib/r_kit/active_record_utility/utility.rb

@@ -1,53 +0,0 @@
-class RKit::ActiveRecordUtility::Utility
-
-  attr_accessor :base, :method
-
-  def initialize base, method:;
-    @base = base
-    @method = method
-  end
-
-
-  def interfere
-    if can_interfere?
-      interfere!
-      interfered!
-    else
-      raise DatabaseSchemaError.new(base, method: method) unless running_script? /^rake db:/
-    end
-  end
-
-
-  # TODO: private/protected ?
-  def can_interfere?
-    raise NotImplementedError, 'Subclasses must implement this method'
-  end
-
-  def interfere!
-    raise NotImplementedError, 'Subclasses must implement this method'
-  end
-
-  def interfered!
-    __class__.interfered base
-  end
-
-
-  module SingletonInheritance
-    def self.extended base
-      base.instance_variable_set :@extended, []
-    end
-
-    def interfered? base
-      @extended.include? base
-    end
-
-    def interfered base
-      @extended << base
-    end
-  end
-
-  def self.inherited(subclass)
-    subclass.extend SingletonInheritance
-    super
-  end
-end