r_kit 0.4.3 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26da20a8c0d5ca239f0b25a5bbd39a3f87a3a115
-  data.tar.gz: 20d9c76c01b2a7fbde0642e280c5ccbdf18fc77a
+  metadata.gz: bf5323abaf73afe8d62b58cb816884632fbdbdcf
+  data.tar.gz: a67bb90a5cdfa7a0b8bd9264107c1e2f8c80ac7b
 SHA512:
-  metadata.gz: 9eb566e05f243773a8b3e3b5959510b3ea8ca9ca901843d22d19ec00200d984c198c571bfffdfe0b4c9ead1144e88d46ad00b3dd655b55778275e7c6e446c8fc
-  data.tar.gz: 24aa528db16c96d5b1cb6b8bc5989c498a4a3b60ab05775cfc231cbac63196f3fe72894ec47411d576f6c34e5293882eb096fc833f4edae86962b2f4c57b5fb2
+  metadata.gz: 27e1256e0174889ca92e9283c207f07ed816fe6f7d4a8cc57defb009c0c4e0339ee5d206682dc9fbb67be275bdff60bb226b712abba852321f0d3fef348a12f6
+  data.tar.gz: c1a6450e8c1ea08ff888dd50e18a8a58753266b98f1cd5e3e5bc23966455acba675af93a095c08e3b721205c0d7630a245f5a5984364b1da887ab678a1c5fac8

data/lib/r_kit/active_record_utility/active_record_extend.rb

@@ -1,39 +1,14 @@
 module RKit::ActiveRecordUtility::ActiveRecordExtend
 
-  RKit::ActiveRecordUtility::UTILITIES.each do |utility, method_name|
-    define_method method_name, ->(*args) do
-      RKit::ActiveRecordUtility::Base.const_get(utility.classify).new(self, method_name: __method__).interfere *args
-    end
-  end
-
-
-  def interferences_options_set utility, **options
-    instance_variable_set "@_active_record_utilities_self", utility
-    instance_variable_set "@_active_record_utilities_#{ utility }_options", options
-  end
-
-  def interferences_options_get utility = @_active_record_utilities_self
-    instance_variable_get "@_active_record_utilities_#{ utility }_options"
-  end
-
-
-  def interfered? utility
-    RKit::ActiveRecordUtility::Base.const_get(utility.classify).interfered? self
-  rescue NameError
-    false
-  end
-
-
   def collection_finder **options
-    collection = all
-    collection = collection.pool options[:pool] if interfered? :pool
-    collection = collection.published.publication_desc if interfered? :publisher
-    collection = collection.series options[:series] if interfered? :series
-    collection
+    all
+      .then(if: :acts_as_poolables?){ |collection| collection.pool options[:pool] }
+      .then(if: :acts_as_publishables?){ |collection| collection.published.publication_desc }
+      .then(if: :acts_as_seriables?){ |collection| collection.series options[:series] }
   end
 
   def instance_finder **options
-    if interfered? :tag
+    if acts_as_taggables?
       tagged options[:tag]
     else
       find_by id: options[:id]

data/lib/r_kit/active_record_utility/database_schema_error.rb

@@ -1,7 +1,9 @@
 class DatabaseSchemaError < StandardError
+  # TODO: does that class already exists ???
+  # TODO: allow to send a custom message, that will replace 2° & 3° lines
   def initialize base, method_name:;
     super %Q{
-WARNING - You tried to use the '#{ method_name }' DSL on '#{ base }',
+DatabaseSchemaError: You tried to use the '#{ method_name }' DSL on '#{ base }',
   Your database is not ready for it yet,
   You can refer to the 'RKit::ActiveRecordUtlity' documentation.
     }

data/lib/r_kit/active_record_utility/utilities/pool.rb

@@ -0,0 +1,41 @@
+class RKit::ActiveRecordUtility::Pool
+  act_as_a_dsl
+
+  name :pool_dsl
+  method :acts_as_poolables
+  domain ActiveRecord::Base
+
+  allowed? do
+    table_exists? &&
+      column_names.include?("pool") &&
+      columns_hash["pool"].type == :string
+  end
+
+  restricted do
+    raise DatabaseSchemaError.new(self, method_name: pool_dsl.method)
+  end
+
+  params ->(**options){}
+
+  methods :class do
+
+    validates_presence_of :pool
+
+    pool_dsl.params.options[:in].then do |inclusion_in|
+      validates_inclusion_of :pool, in: inclusion_in
+    end
+
+    scope :pool, ->(pool){ pool && where(pool: pool) }
+    scope :pools, ->{ group(:pool).pluck(:pool) }
+  end
+
+  methods :decorator do
+    def pool_url
+      view.url_for [__class__, pool: pool]
+    end
+
+    def link_to_pool
+      view.link_to pool, pool_url, class: :btn
+    end
+  end
+end

data/lib/r_kit/active_record_utility/utilities/publisher.rb

@@ -0,0 +1,38 @@
+class RKit::ActiveRecordUtility::Publisher
+  act_as_a_dsl
+
+  name :publisher_dsl
+  method :acts_as_publishables
+  domain ActiveRecord::Base
+
+  allowed? do
+    table_exists? &&
+      column_names.include_all?(["published", "published_at"]) &&
+      columns_hash["published"].type == :boolean &&
+      columns_hash["published_at"].type == :datetime
+  end
+
+  restricted do
+    raise DatabaseSchemaError.new(self, method_name: publisher_dsl.method)
+  end
+
+
+  methods :class do
+    before_validation do
+      self.published_at = Time.now if !published_at && published
+    end
+
+    validates_presence_of :published_at, if: :published
+
+    scope :published, ->{ where(published: true) }
+    scope :publication_asc, ->{ order("published_at ASC") }
+    scope :publication_desc, ->{ order("published_at DESC") }
+  end
+
+  methods :decorator do
+    def published_at
+      super().strftime "%a %e %b %Y"
+    end
+  end
+
+end

data/lib/r_kit/active_record_utility/{base → utilities}/series.rb

@@ -1,6 +1,33 @@
-class RKit::ActiveRecordUtility::Base::Series < RKit::ActiveRecordUtility::Base
+class RKit::ActiveRecordUtility::Series
+
+  # TODO: series must change to smthing bigger (maybe a service for itself)
+  # I want the "serie" to have its own DB-Table
+  # with tag, title, brief & custom-paginable
+  # (the custom paginable, could use only the pagination decorator, or a new dsl that inherit from paginable)
+  # and I want to be able to display the series's title+brief if needed
+  # (for example, when the scope "first_of_series" is called)
+  # TODO: maybe rename to "thread" ?
+
+  act_as_a_dsl
+
+  name :series_dsl
+  method :acts_as_seriables
+  domain ActiveRecord::Base
+
+  allowed? do
+    table_exists? &&
+      column_names.include_all?(["following_id", "series"]) &&
+      columns_hash["following_id"].type == :integer &&
+      columns_hash["series"].type == :string
+  end
+
+  restricted do
+    raise DatabaseSchemaError.new(self, method_name: series_dsl.method)
+  end
+
+
 
-  instance_interferences do
+  methods :class do
     has_one :followed, class_name: name, foreign_key: "following_id"
     belongs_to :following, class_name: name
 
@@ -32,13 +59,15 @@ class RKit::ActiveRecordUtility::Base::Series < RKit::ActiveRecordUtility::Base
 
     # TODO: scope pour l'ordre dans une serie (pour le decorator pagination_tag)
 
-    @@_active_record_utilities_series = {}
+    # @@_active_record_utilities_series = {}
   end
 
-  class_interferences do
+
+  methods :instance do
     def series
-      @@_active_record_utilities_series[read_attribute(:series)] ||= series_struct if read_attribute(:series)
-      # TODO: if series cg-hanges, or new element added, series must be re-calculated
+      series_struct if read_attribute(:series)
+      # @@_active_record_utilities_series[read_attribute(:series)] ||= series_struct if read_attribute(:series)
+      # TODO: if series changes, or new element added, series must be re-calculated
       # maybe pre-calc this in after save
     end
 
@@ -55,7 +84,8 @@ class RKit::ActiveRecordUtility::Base::Series < RKit::ActiveRecordUtility::Base
     end
   end
 
-  decorator_interferences do
+
+  methods :decorator do
     after_initialize do
       # TODO: this can't stay this way, if "serie" is pre-calculated
       # & shared accros instances & kept in memory (class variable)
@@ -73,8 +103,8 @@ class RKit::ActiveRecordUtility::Base::Series < RKit::ActiveRecordUtility::Base
       view.link_to series.name, series_url, class: :btn
     end
 
-    if decorated_klass.columns_hash["title"]
-      # I don't get this "showcase thing", we can delete that and just look into the view for the params
+    if decorated_class.columns_hash["title"]
+      # TODO: I don't get this "showcase thing", we can delete that and just look into the view for the params
       # Or in the collection, to see if the scope is applied (second solution is better)
       def series_title
         "#{ __getobj__.title } <small><i class='no-warp'>(vol #{ position_in_series })</i></small>".html_safe
@@ -132,10 +162,5 @@ class RKit::ActiveRecordUtility::Base::Series < RKit::ActiveRecordUtility::Base
   end
 
 
-  def can_interfere?
-    base.table_exists? &&
-      base.column_names.include_all?(["following_id", "series"]) &&
-      base.columns_hash["following_id"].type == :integer &&
-      base.columns_hash["series"].type == :string
-  end
+
 end

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

@@ -0,0 +1,30 @@
+class RKit::ActiveRecordUtility::Tag
+  act_as_a_dsl
+
+  name :tag_dsl
+  method :acts_as_taggables
+  domain ActiveRecord::Base
+
+  allowed? do
+    table_exists? &&
+      column_names.include?("tag") &&
+      columns_hash["tag"].type == :string
+  end
+
+  restricted do
+    raise DatabaseSchemaError.new(self, method_name: tag_dsl.method)
+  end
+
+
+  methods :class do
+    validates_presence_of :tag
+    validates_uniqueness_of :tag
+
+    def tagged(tag) find_by tag: tag end
+  end
+
+  methods :instance do
+    def to_param() tag end
+  end
+
+end

data/lib/r_kit/active_record_utility.rb

@@ -1,24 +1,23 @@
 class RKit::ActiveRecordUtility
-  dependency :utilities
 
-  load_path __FILE__, 'base.rb'
-  load_path __FILE__, 'database_schema_error.rb'
+  dependency :dsl,
+    :utility
 
-  load_path __FILE__, 'active_record_extend.rb'
+  load_path __FILE__,
+    'active_record_extend',
+    'database_schema_error'
 
 
-  UTILITIES = {
-    pool: :acts_as_poolables,
-    publisher: :acts_as_publishables,
-    series: :acts_as_seriables,
-    tag: :acts_as_taggables,
-  }
-
+  UTILITIES = Dir[File.join(File.dirname(__FILE__), "active_record_utility/utilities", "*.rb")].map do |file|
+    File.basename file, ".rb"
+  end
 
   config :all, true
 
-  UTILITIES.each do |utility, _|
+  UTILITIES.each do |utility|
+
+
     alias_config utility, :all
-    load_path __FILE__, "base/#{ utility }.rb", if: utility
+    load_path __FILE__, "utilities/#{ utility }", if: utility
   end
 end

data/lib/r_kit/backtrace.rb

@@ -4,6 +4,6 @@ class RKit::Backtrace
   # we may want to put a warning if the gem 'binding_of_caller' is not included
   # or we could directly include the C enxtention, with permission of the owner of the gem
 
-  load_path __FILE__, 'kernel_extend.rb'
+  load_path __FILE__, 'kernel_extend'
 
 end

data/lib/r_kit/core/loader/dependency.rb

@@ -13,9 +13,9 @@ class Dependency
   # TODO: The dependency warning msg should be in service object
   def dependency!
     warn %Q{
-WARNING - #{ service.name } was implicitly loaded,
-As a dependency for #{ base }.
-You may want to load it explicitly.
+WARNING - #{ service.name } will be implicitly loaded,
+  As a dependency for #{ base }.
+  You may want to load it explicitly.
     }
     service.load
   end

data/lib/r_kit/core/loader/load_path.rb

@@ -2,12 +2,14 @@ class LoadPath
   attr_accessor :_base,
     :file, :path, :priority, :conditions
 
-  def initialize base, file:, path:, priority: 1/0.0
+  def initialize base, file:, path:, **options
     @_base = base
 
     @file = file
     @path = path
-    @priority = priority
+
+    @priority = options.fetch :priority, 1/0.0
+    @conditions = options.slice :if, :unless
   end
 
 
@@ -17,7 +19,7 @@ class LoadPath
 
   def fullpath
     file.chomp! File.extname(file)
-    File.expand_path(path, file)
+    File.expand_path(path, file) << ".rb"
   end
 
 

data/lib/r_kit/core/loader.rb

@@ -1,14 +1,14 @@
 class RKit::Core::Loader
   attr_accessor :_base, :load_paths, :dependencies
 
-  @@loaded = []
+  @loaded = []
 
   def self.loaded
-    @@loaded.map{ |name| name.demodulize.underscore }
+    @loaded.map{ |name| name.demodulize.underscore }
   end
 
   def self.loaded? name
-    @@loaded.include? name
+    @loaded.include? name
   end
 
 
@@ -19,8 +19,12 @@ class RKit::Core::Loader
   end
 
 
-  def dependency dependency
-    dependencies << Dependency.new(_base, service: dependency)
+  # TODO: when a dependency is added, we must define in the opposite service a "dependency forbidden"
+  # TODO: in order to avoid recursive dependency
+  def dependency *services
+    services.each do |service|
+      dependencies << Dependency.new(_base, service: service)
+    end
   end
 
   def dependencies!
@@ -28,11 +32,10 @@ class RKit::Core::Loader
   end
 
 
-  def load_path file, path, **options
-    load_path = LoadPath.new _base, file: file, path: path, **options.slice(:priority)
-    load_path.conditions = options.slice :if, :unless
-
-    load_paths << load_path
+  def load_path file, *paths, **options
+    paths.each do |path|
+      load_paths << LoadPath.new(_base, file: file, path: path, **options.slice(:priority, :if, :unless))
+    end
   end
 
   def load_paths!
@@ -41,7 +44,7 @@ class RKit::Core::Loader
 
 
   def loaded!
-    @@loaded << _base.name
+    __class__.instance_variable_get("@loaded") << _base.name
   end
 
 

data/lib/r_kit/core.rb

@@ -23,7 +23,7 @@ class RKit::Core
 
     def with_sprockets file
       @_engine.sprockets = true
-      load_path file, 'sass_extend.rb'
+      load_path file, 'sass_extend'
     end
 
 
@@ -65,8 +65,10 @@ class RKit::Core
   end
 
 
+  # TODO: configurer need some sort of wrapper & things, this needs to be largely improved
   require 'r_kit/core/configurer.rb'
 
+  # TODO: make engine mountable AFTER rails initialization
   require 'r_kit/core/engineer.rb'
 
   require 'r_kit/core/loader.rb'

data/lib/r_kit/decoration/action_view_base_extend.rb

@@ -1,20 +1,21 @@
 module RKit::Decoration::ActionViewBaseExtend
 
   def assign new_assigns
-    _decorate_assigns new_assigns if RKit::Decoration.config.auto_decoration
+    decorate_assigns new_assigns
 
     super
   end
 
 
-  def _decorate_assigns assigns
+  protected def decorate_assigns assigns
     assigns.dup.each do |key, value|
-      assigns[key] = _decorate value
+      assigns[key] = decorate value
     end
   end
 
-  def _decorate assign
+  protected def decorate assign
     if assign.respond_to? :decorate
+      p "go in decorate"
       assign.decorate view_context: self
     else
       assign

data/lib/r_kit/decoration/base/collection.rb

@@ -0,0 +1,20 @@
+class RKit::Decoration::Collection < CollectionDelegator
+  include RKit::Decoration::Base
+
+
+  attr_accessor :safe_mode
+
+  def safe() tap{ @safe_mode = true } end
+  def unsafe() tap{ @safe_mode = false } end
+
+
+  def each &block
+    collection.each do |object|
+      if safe_mode && object.dont_respond_to?(:decorate)
+        block.call object
+      else
+        block.call object.decorate(view_context: view)
+      end
+    end
+  end
+end

data/lib/r_kit/decoration/base/object.rb

@@ -0,0 +1,21 @@
+class RKit::Decoration::Object < SimpleDelegator
+  include RKit::Decoration::Base
+
+
+  singleton_attr_reader :decorated_class
+  singleton_attr_reader :after_initialize_procs, default: proc{ [] }
+
+  def self.after_initialize &block
+    after_initialize_procs << block
+  end
+
+  def after_initialize!
+    decorator_class.after_initialize_procs.each{ |after_initialize_proc| self.instance_eval &after_initialize_proc }
+  end
+
+
+  def initialize obj, view_context: nil
+    super
+    after_initialize!
+  end
+end

data/lib/r_kit/decoration/base.rb

@@ -1,35 +1,31 @@
-require 'delegate'
+module RKit::Decoration::Base
 
-class RKit::Decoration::Base < SimpleDelegator
+  def initialize object, view_context: nil
+    @view_context = view_context
+    super object
+  end
+
+  alias :decorator_class :class
+  delegate :class, to: :__getobj__
 
-  singleton_attr_reader :decorated_klass
-  singleton_attr_reader :after_initialize_procs, default: proc{ [] }
 
-  def self.after_initialize &block
-    after_initialize_procs << block
+  def decorate *args
+    self
   end
 
-  def initialize obj, view_context: nil
-    @_view_context = view_context
-    super obj
+  def decorated?() true end
 
-    decorator_klass.after_initialize_procs.each{ |after_initialize_proc| self.instance_eval &after_initialize_proc }
+  def raw
+    __getobj__
   end
 
-  alias :decorator_klass :class
-  delegate :class, to: :__getobj__
 
-
-  def _view_context
+  private def view_context
     backtrace{ |obj| obj.is_a? ActionView::Base } || backtrace{ |obj| obj.respond_to? :view_context }.view_context
   end
 
   def view
-    @_view_context ||= _view_context
+    @view_context ||= view_context
   end
 
-
-  def === object
-    self == object || __getobj__ == object
-  end
 end

data/lib/r_kit/decoration/class.rb

@@ -1,22 +1,111 @@
 class RKit::Decoration::Class
 
-  module OpenClass
-    refine Class do
-      def new super_class = Object, **options, &block
-        super(super_class, &block).tap do |klass|
-          options.each{ |key, value| klass.instance_variable_set "@#{ key }", value }
-        end
-      end
+  class << self
+    alias :basic_new :new
+    def new *args, &block
+      basic_new(*args, &block).decorator
     end
   end
-  using OpenClass
 
-  # TODO: improve this "new" method, in order to move the creation of the decoraor klass for ARextend to here
-  # ot should be able to accept a proc, a module, a class, or nil(autodetect)
-  # -- While doing so, U could move the logic of Class.to_module && Module.to_class && Proc.to_class in "utilities" (or new rkit service)
-  def self.new decorated_klass, &block
-    Class.new(RKit::Decoration::Base, decorated_klass: decorated_klass, &block).tap do |klass|
-      klass.class_eval{ alias :"#{ decorated_klass.demodulize.underscore }" :__getobj__ }
+
+  def initialize decorated, from: nil, &block
+    @decorated = decorated
+    @from = from
+    @block = block || proc{}
+  end
+
+
+  def decorator
+    decorator_from(@from)
+      .tap{ |decorator| decorator.instance_variable_set "@decorated_class", @decorated }
+      .tap{ |decorator| decorator.class_eval{ alias :"#{ decorated_class.demodulize.underscore }" :__getobj__ } }
+      .tap{ |decorator| decorator.class_eval &@block }
+  end
+
+
+
+  protected def decorator_from from
+    send "decorator_from_#{ from.class.underscore }", from
+  end
+
+
+  protected def decorator_from_nil_class *_
+    decorator_from "#{ @decorated.demodulize }Decorator"
+  end
+
+  protected def decorator_from_string name
+    decorator_from(
+      @decorated
+        .namespace
+        .const_get name, default: Class.new(RKit::Decoration::Object)
+    )
+  end
+
+  alias :decorator_from_symbol :decorator_from_string
+
+  # TODO: method module_to_class(superclass)
+  def decorator_from_module mod
+    mod
+      .namespace
+      .const_replace mod.demodulize,
+        Class.new(RKit::Decoration::Object){ include mod }
+  end
+
+  def decorator_from_class base
+    if base <=> RKit::Decoration::Object
+      base
+    else
+      # TODO: method class_to_module
+      # TODO: method class.add_ancestor(superclass)
+      base.tap do |base|
+        base.send :include, Module.new{ include refine(RKit::Decoration::Object){} }
+        base.extend Module.new{ include refine(RKit::Decoration::Object.singleton_class){} }
+        base.instance_variable_set "@decorated_class", @decorated
+        base.class_eval{ alias :"#{ decorated_class.demodulize.underscore }" :__getobj__ }
+      end
     end
   end
 end
+
+
+# # TODO: all the methods below this comment should be private, even more, they should be in a "decorator_finder_creator_definer", and not included in active_record. SRP guys !
+# def define_decorator arg
+#   @decorator_klass = decorator_klass_from arg
+#   @decorator_klass
+# end
+#
+#
+# def decorator_klass_from arg
+#   send "decorator_klass_from_#{ arg.class.name.underscore }", arg
+# end
+#
+# def decorator_klass_from_nil_class *args
+#   decorator_klass_from "#{ name }Decorator".constantize
+# end
+#
+# def decorator_klass_from_class base
+#   if base <=> RKit::Decoration::Base
+#     base
+#   else
+#     base.tap do |base|
+#       base.send :include, Module.new{ include refine(RKit::Decoration::Base){} }
+#       base.extend Module.new{ include refine(RKit::Decoration::Base.singleton_class){} }
+#       base.instance_variable_set "@decorated_klass", self
+#       base.class_eval{ alias :"#{ decorated_klass.demodulize.underscore }" :__getobj__ }
+#     end
+#   end
+# end
+#
+# def decorator_klass_from_module mod
+#   namespace = (mod.name.deconstantize.presence || 'Object').constantize
+#   const_name = mod.name.demodulize
+#
+#   namespace.send :remove_const, const_name
+#   namespace.const_set const_name, RKit::Decoration::Class.new(self){ include mod }
+# end
+#
+# def decorator_klass_from_proc block
+#   (name.deconstantize.presence || 'Object')
+#     .constantize
+#     .const_set "#{ name.demodulize }Decorator", RKit::Decoration::Class.new(self, &block)
+# end