r_kit 0.4.3 → 0.5

data/lib/r_kit/decoration/dsl.rb

@@ -0,0 +1,121 @@
+class RKit::Decoration::Dsl
+  act_as_a_dsl
+
+  name :decoration_dsl
+  method :acts_as_decorables
+  domain ActiveRecord::Base
+
+
+  params ->(from = nil, &block){}
+
+  methods :class do
+
+    @decorator_class = RKit::Decoration::Class.new self,
+      from: decoration_dsl.params.from,
+      &decoration_dsl.params.block
+
+    def decorator_class
+      @decorator_class
+    end
+
+    # TODO: this couls move in "ennumerable", cause if the AR::relation is mapped into an array
+    # or if we create an array with decorables objects in it
+    # this will fail
+    # --
+    # in addition, make a "safe_decorate" for collections, wich will decorate if respond_to_decorate,
+    # and will not raise error
+    # TODO: act as paginable can not be used, because of decoration (implicit here)
+    # decorated paginated collection still work fine
+    # but non paginated collection, becomes dumb arrays
+    # def decorate view_context: nil
+    #   all.map{ |record| record.decorate view_context: view_context }
+    # end
+
+    def decorate **options
+      RKit::Decoration::Collection.new all, **options
+    end
+
+    def decorated?() false end
+
+  end
+
+
+  methods :instance do
+
+    def decorate **options
+      __class__.decorator_class.new self, **options
+    end
+
+    def decorated?() false end
+
+  end
+end
+
+
+
+
+# attr_accessor :decorator_klass
+#
+# def acts_as_decorables base = nil, &block
+#   define_decorator base || block
+#   define_instance_methods
+# 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
+#
+# # TODO: this couls move in "ennumerable", cause if the AR::relation is mapped into an array
+# # or if we create an array with decorables objects in it
+# # this will fail
+# # --
+# # in addition, make a "safe_decorate" for collections, wich will decorate if respond_to_decorate,
+# # and will not raise error
+# def decorate view_context: nil
+#   all.map{ |record| record.decorate view_context: view_context }
+# end
+#
+#
+# def define_instance_methods
+#   define_method 'decorate' do |view_context: nil|
+#     self.class.decorator_klass.new self, view_context: view_context
+#   end
+# end

data/lib/r_kit/decoration/enumerable_extend.rb

@@ -0,0 +1,9 @@
+module Enumerable
+
+  def decorate **options
+    RKit::Decoration::Collection.new(self, **options).safe
+  end
+
+  def decorated?() false end
+
+end

data/lib/r_kit/decoration.rb

@@ -5,15 +5,22 @@ class RKit::Decoration
   # and if not, we do not require the "view_context" (well, we could not, I think)
   # (the only case is if the user define a block elswhere than in the view or in the controller, and use it)
   # (but this case will fail today as well, I think)
-  dependency :backtrace
+  # -> pb w/ backtrace in console (Screencast.limit(5).decorate.map{|x|x} -> infinite loop)
+  dependency :backtrace,
+    :dsl,
+    :utility
 
 
-  load_path __FILE__, 'base.rb'
-  load_path __FILE__, 'class.rb'
+  load_path __FILE__,
+    'base',
+    'base/collection',
+    'base/object',
+    'class',
+    'dsl',
+    'enumerable_extend'
 
-  load_path __FILE__, 'action_view_base_extend.rb'
-  load_path __FILE__, 'active_record_extend.rb'
+  load_path __FILE__, 'action_view_base_extend', if: :implicit_decoration
 
 
-  config :auto_decoration, true
+  config :implicit_decoration, true
 end

data/lib/r_kit/dsl/base/local_params.rb

@@ -5,9 +5,12 @@ module RKit::Dsl::Base::LocalParams
   end
 
   def method_missing method_name, *args, &block
-    persisting_binding.eval method_name.to_s
-  rescue
-    super
+    case method_name
+    when *persisting_binding.eval("local_variables")
+      persisting_binding.eval method_name.to_s
+    else
+      super
+    end
   end
 
 end

data/lib/r_kit/dsl/base/thrust.rb

@@ -24,7 +24,7 @@ class RKit::Dsl::Base
       end
 
       @base.send :define_singleton_method, @method do
-        @@dsls[name]
+        RKit::Dsl::Base.dsls[name]
       end
     end
 
@@ -53,7 +53,9 @@ class RKit::Dsl::Base
 
           instance_eval &send(name).methods[:class]
           class_eval &send(name).methods[:instance]
-          decorator_klass.class_eval &send(name).methods[:decorator] if respond_to? :decorator_klass
+          if respond_to?(:acts_as_decorables?) && acts_as_decorables?
+            decorator_class.class_eval &send(name).methods[:decorator]
+          end
 
           true
         end

data/lib/r_kit/dsl/base.rb

@@ -1,9 +1,11 @@
 class RKit::Dsl::Base
 
-  @@dsls = Hash.new{ |hash, key| hash[key] = Array.new }
+  @dsls = Hash.new{ |hash, key| hash[key] = Array.new }
   def self.dsls
-    @@dsls
+    @dsls
   end
+  ::DSLS = @dsls
+
 
   attr_accessor :base
 
@@ -19,6 +21,7 @@ class RKit::Dsl::Base
   end
 
 
+  # TODO: vérifier l'unicité du "name"
   def name name
     @name = name
   end
@@ -31,12 +34,16 @@ class RKit::Dsl::Base
   def domain domain
     raise DslDefinitionError.new(@base) if [@name, @method].none?
 
-    @domain = domain
+    @domain ||= domain
+
+    shadow :domain do |shadow_self|
+      shadow_self.instance_variable_set "@domain", domain
 
-    thrust_dsl!
-    thrust_dsl_interface!
-    thrust_dsl_options!
-    thrust_dsl_extend!
+      thrust_dsl!
+      thrust_dsl_interface!
+      thrust_dsl_options!
+      thrust_dsl_extend!
+    end
   end
 
 

data/lib/r_kit/dsl.rb

@@ -2,20 +2,71 @@ class RKit::Dsl
 
   dependency :struct
 
-  load_path __FILE__, 'base.rb'
-  load_path __FILE__, 'base/local_params.rb'
-  load_path __FILE__, 'base/params.rb'
-  load_path __FILE__, 'base/readonly.rb'
-  load_path __FILE__, 'base/thrust.rb', priority: 1
+  load_path __FILE__,
+    'base',
+    'base/local_params',
+    'base/params',
+    'base/readonly'
 
-  load_path __FILE__, 'dsl_definition_error.rb'
-  load_path __FILE__, 'dsl_standard_error.rb'
-  load_path __FILE__, 'no_lambda_error.rb'
+  load_path __FILE__, 'base/thrust', priority: 1
 
-  load_path __FILE__, 'dsl_extend.rb'
-  load_path __FILE__, 'module_extend.rb'
+  load_path __FILE__,
+    'dsl_definition_error',
+    'dsl_standard_error',
+    'no_lambda_error'
 
+  load_path __FILE__,
+    'dsl_extend',
+    'module_extend'
 
-  load_path __FILE__, 'test.rb'
+
+
+  # TODO: Handle dsl inheritance
+  # class X; acts_as_a_dsl; restricted do ... end; end
+  # class Y < X; name+method+domain end
+  # and allow to use 'super'
+  # ->
+  # this can be achieved defining 'inerited' on dsl_extend (not 'self.inherited')
+  # at this point, we create the @_dsl with a copy of the previous one, except 'name' 'method'
+  # pb is for 'domain', wich is normally the trigger to thrust
+  # ->
+  # and we need to also handle the 'domain' on the parent class
+  # on that, it need not trigger the 'thrust'
+
+  # TODO: semi-linked to inheritance, allow to define methods via multiple blocks
+  # so if a block is already define, just add the new one to the old one
+  # TODO: also allow to 'override' completely the old block declaration
+  # (maybe 'methods instance: :override do ... end')
+
+  # TODO: Handle correctly the possibility to add the dsl in other domains
+  # today, it's done via "shadowing" the @domain
+
+  # TODO: The "readonly" mode should be the default mode for everyone,
+  # except (of course) the dsl_declaration class (the class that used 'act_as_dsl')
+  # -> to do that, either, interchage all the methods (painfull)
+  # -> or, try to replace the const_name when 'act_as_dsl' is used (pb when re-opening the class ?)
+
+  # TODO: rkit: on dsl, I lac of a callback when dsl is put in another class
+  # (like a 'def self.decorated(decorator)' for example).
+  # I know I can put the code in 'class methods',
+  # but I may also want a specific callback from the calling class ?
+  # (maybe smthng like "before_acts_as_X + after_act_as_X") ("self.yanked" "self.X-ed")
+
+  # TODO: make smthing to define methods on the "domain" level
+  # for example, in the series dsl, I could define a method "per_page" in all the domain, that would return '[]'
+  # and when dsl is added, that would return an array with all the series
+  # --> before doing that, find a real use case, it may be a duplication of 'can_as_as_X?'
+
+  # TODO: this service could be totaly rework
+  # instead of actually adding behavior in classes
+  # it only create a Delegator object, with the behavior inside it
+  # then, it delegates all methods defined by the 'dsl' to this Delegator object
+  # --> maybe this is the idea behind the 'context/puppet' service
+  # --> and may be not good for DSL
+  # acts_as_dsl -> will add 'sinpleDelegator' to the ancestors -> then -> name(?)+method+domain
+  # then -> def self.clas_method, -> def instance_method
+  # then, in host class -> act_as_x -> define "@X", X_delegator(self), delegate *X.methods, to: @X
+
+  # load_path __FILE__, 'test'
 
 end

data/lib/r_kit/grid.rb

@@ -3,14 +3,15 @@ class RKit::Grid
   with_engine __FILE__
   with_sprockets __FILE__
 
-  load_path __FILE__, 'base.rb'
-  load_path __FILE__, 'base/grid.rb'
-  load_path __FILE__, 'base/grid_col.rb'
-  load_path __FILE__, 'base/grid_row.rb'
-  load_path __FILE__, 'binding.rb'
-
-  load_path __FILE__, 'enumerable_extend.rb', if: :enumerable_extend
-  load_path __FILE__, 'kernel_extend.rb', if: :kernel_extend
+  load_path __FILE__,
+    'base',
+    'base/grid',
+    'base/grid_col',
+    'base/grid_row',
+    'binding'
+
+  load_path __FILE__, 'enumerable_extend', if: :enumerable_extend
+  load_path __FILE__, 'kernel_extend', if: :kernel_extend
 
 
   config :extends, true

data/lib/r_kit/pagination/base/page.rb

@@ -8,7 +8,7 @@ class RKit::Pagination::Base::Page
   end
 
 
-  extend RKit::Decoration::ActiveRecordExtend
+  RKit::Decoration::Dsl.domain self
   acts_as_decorables do
 
     # TODO: we tried to cancel the underscored alias of __getobj__

data/lib/r_kit/pagination/base.rb

@@ -1,32 +1,15 @@
-class RKit::Pagination::Base < SimpleDelegator
-
-  # TODO: use collection delegator newly done in 'strcut'
-
-  alias :collection :__getobj__
-  alias :collection= :__setobj__
+class RKit::Pagination::Base < CollectionDelegator
 
   attr_accessor :page, :per_page
 
-  # TODO: should raise an error if has "limit" or "offset" values
+  # TODO: should raise (todo custom error) 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
+    @page = options[:page] || 1
+    @per_page = options[:per_page] || RKit::Pagination.config.per_page[collection.klass]
   end
 
   tap_attr_accessor :page
@@ -47,8 +30,6 @@ class RKit::Pagination::Base < SimpleDelegator
   end
 
 
-  include Enumerable
-
   def limited_collection
     collection
       .limit(per_page)
@@ -79,7 +60,7 @@ class RKit::Pagination::Base < SimpleDelegator
 
 
 
-  extend RKit::Decoration::ActiveRecordExtend
+  RKit::Decoration::Dsl.domain self
   acts_as_decorables do
 
     include Enumerable

data/lib/r_kit/pagination/dsl.rb

@@ -0,0 +1,15 @@
+module RKit::Pagination::Dsl
+  act_as_a_dsl
+
+  name :pagination_dsl
+  method :acts_as_paginables
+  domain ActiveRecord::Base
+
+  methods :class do
+
+    def paginate page: nil, per_page: nil
+      RKit::Pagination::Base.new(all, page: page, per_page: per_page)
+    end
+
+  end
+end

data/lib/r_kit/pagination.rb

@@ -1,13 +1,16 @@
 class RKit::Pagination
 
-  dependency :decoration
-  dependency :utility
+  dependency :decoration,
+    :dsl,
+    :struct,
+    :utility
 
 
-  load_path __FILE__, 'base.rb'
-  load_path __FILE__, 'base/page.rb'
+  load_path __FILE__,
+    'base',
+    'base/page',
+    'dsl'
 
-  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) }

data/lib/r_kit/struct/safe_struct.rb

@@ -29,6 +29,9 @@ class SafeStruct
           options
         end
       end
+
+      delegate :slice,
+        to: :to_hash
     end
   end
 

data/lib/r_kit/struct.rb

@@ -2,7 +2,9 @@ class RKit::Struct
 
   dependency :utility
 
-  load_path __FILE__, 'safe_struct.rb'
-  load_path __FILE__, 'strong_struct.rb'
+  load_path __FILE__,
+    'collection_delegator',
+    'safe_struct',
+    'strong_struct'
 
 end

data/lib/r_kit/utility/basic_object_extend.rb

@@ -0,0 +1,5 @@
+class BasicObject
+  def __class__
+    self.class
+  end
+end

data/lib/r_kit/utility/kernel_extend.rb

@@ -1,19 +1,59 @@
 module Kernel
 
-  def __class__
-    self.class
+  def running_script
+    "#{ File.basename($0) } #{ ARGV.join " " }"
   end
 
-  def __namespace__
-    (__class__.name.deconstantize.presence || 'Object').constantize
+  def running_script? script
+    Regexp.new(script) =~ running_script
   end
 
 
-  def running_script
-    "#{ File.basename($0) } #{ ARGV.join " " }"
+  # TODO: think about a 'else' method => x.then{}.else{}
+  # it could be done, when the 'then' return 'nil', we define an instance var in the singleton (possible on nil ?)
+  # then reuse that into the else, as an arg to the block
+  def then **options, &block
+    if self && conditionnal_statement(options)
+      block.call(self)
+    else
+      self
+    end
   end
 
-  def running_script? script
-    Regexp.new(script) =~ running_script
+  def conditionnal_statement **options
+    options.slice(:if, :unless).reduce(true) do |continue, (statement, method_name)|
+      continue && send(method_name).tap do |closure|
+        case statement
+        when :if
+          !!closure
+        when :unless
+          !closure
+        end
+      end
+    end
+  end
+
+
+
+  def shadow *names, &block
+    saved_state = names.reduce({}) do |saved_state, name|
+      saved_state[name] = instance_variable_get name.ivar
+      saved_state
+    end
+
+    closure = block.call(self)
+
+    names.each do |name|
+      instance_variable_set name.ivar, saved_state[name]
+    end
+
+    closure
   end
+
+
+
+  def dont_respond_to? *args, &block
+    !respond_to? *args, &block
+  end
+
 end

data/lib/r_kit/utility/module_extend.rb

@@ -1,8 +1,13 @@
 class Module
 
-  delegate :underscore, :demodulize,
+  delegate :deconstantize, :demodulize, :underscore,
     to: :name
 
+  def namespace
+    (deconstantize.presence || 'Object').constantize
+  end
+
+
 
   alias :basic_attr_reader :attr_reader
   def attr_reader *names, default: nil
@@ -40,4 +45,20 @@ class Module
   def singleton_attr_reader *args, **options
     singleton_class.send :attr_reader, *args, **options
   end
+
+
+  alias :basic_const_get :const_get
+  def const_get name, *args, default: nil
+    if default && !const_defined?(name)
+      name.safe_constantize ||
+        const_set(name, default)
+    else
+      basic_const_get name, *args
+    end
+  end
+
+  def const_replace name, value
+    remove_const name
+    const_set name, value
+  end
 end

data/lib/r_kit/utility/simple_delegator_extend.rb

@@ -1,7 +1,11 @@
 class SimpleDelegator
 
-  # TODO: get some methods from decorator, like "class", "==="
-  # TODO: and add some custom like "inspect"
+  # TODO: add delegation for "inspect" to getobj
+
+  # TODO: allow singleton methods to be delegated (note, can not override them)
+  # TODO: by defining a method missing on singleton_class
+  # TODO: or better (?), defining a delegator for the singleton_class
+
 
   def self.getobj_attr_reader *names
     names.each do |name|
@@ -9,4 +13,9 @@ class SimpleDelegator
     end
   end
 
+
+  def === object
+    self == object || __getobj__ == object
+  end
+
 end

data/lib/r_kit/utility.rb

@@ -9,11 +9,21 @@ class RKit::Utility
 
   UTILITIES.each do |utility|
     alias_config "#{ utility }_extend", :extends
-    load_path __FILE__, "#{ utility }_extend.rb", if: "#{ utility }_extend"
+    load_path __FILE__, "#{ utility }_extend", if: "#{ utility }_extend"
   end
 
   # TODO: class_extend: to_module, ancestor=
   # TODO: module_extend: to_class
   # TODO: enumerable_extend/or-array_extend: with_indifferent_access
   # TODO: get back some code from hash_extend && array_extend gems
+
+
+  # TODO: Today, the files are structured by class they extend, not by feature
+  # TODO: we first encounter a feature multi class with the 'then' menthod (kernel, nil, false)
+  # -> not true anymore for 'then', it's only in kernel now
+  # TODO, maybe, we should create a module/feature, then include the modules into corresponding classes
+  # TODO: and, this has the advantage to be more readable on a RKit::CONFIG point of view (POV)
+
+  # TODO: in Module: method "override", qui alias l'ancienne méthode, et redéfinit la nouvelle
+  # TODO: ou, qui crée un module, et le prepend, pour utiliser "super"
 end

data/lib/r_kit/version.rb

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