r_kit 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d98f71dcaea265f716ff792fad147279f44b4287
-  data.tar.gz: 217d736a30a4f845b3d976b1c2c2ca1fbbb7df6b
+  metadata.gz: 26da20a8c0d5ca239f0b25a5bbd39a3f87a3a115
+  data.tar.gz: 20d9c76c01b2a7fbde0642e280c5ccbdf18fc77a
 SHA512:
-  metadata.gz: 1ecb5dd37f794116e6128d7376b8ede61fb06e6d1f4cb41aa4285d894581d472cf0655477108841299b37a936bd2eadcf001f08eb46b7eb104002b1ffe3e6782
-  data.tar.gz: f5da4ecd90a62e5256d531a2a5fad1b543478bfb7a0c8116c12624af626a19258ea773176df1ae401e61d081785ea21c5543c5cca2fbfc858b143f2e7d2e2a7f
+  metadata.gz: 9eb566e05f243773a8b3e3b5959510b3ea8ca9ca901843d22d19ec00200d984c198c571bfffdfe0b4c9ead1144e88d46ad00b3dd655b55778275e7c6e446c8fc
+  data.tar.gz: 24aa528db16c96d5b1cb6b8bc5989c498a4a3b60ab05775cfc231cbac63196f3fe72894ec47411d576f6c34e5293882eb096fc833f4edae86962b2f4c57b5fb2

data/lib/r_kit/active_record_utility/active_record_extend.rb

@@ -1,18 +1,45 @@
 module RKit::ActiveRecordUtility::ActiveRecordExtend
 
   RKit::ActiveRecordUtility::UTILITIES.each do |utility, method_name|
-
-    define_method method_name do
-      RKit::ActiveRecordUtility::Utility.const_get(utility.classify).new(self, method: __method__).interfere
+    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::Utility.const_get(utility.classify).interfered? model_klass
+    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
+  end
+
+  def instance_finder **options
+    if interfered? :tag
+      tagged options[:tag]
+    else
+      find_by id: options[:id]
+    end
+  end
+
+
   ActiveRecord::Base.extend self
 end

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

@@ -0,0 +1,29 @@
+class RKit::ActiveRecordUtility::Base::Pool < RKit::ActiveRecordUtility::Base
+
+  instance_interferences do
+    inclusion_in = interferences_options_get.fetch :in
+
+    validates_presence_of :pool
+    validates_inclusion_of :pool, in: inclusion_in if inclusion_in
+
+    scope :pool, ->(pool){ pool && where(pool: pool) }
+    scope :pools, ->{ group(:pool).pluck(:pool) }
+  end
+
+  decorator_interferences 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
+
+
+  def can_interfere?
+    base.table_exists? &&
+      base.column_names.include?("pool") &&
+      base.columns_hash["pool"].type == :string
+  end
+end

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

@@ -0,0 +1,28 @@
+class RKit::ActiveRecordUtility::Base::Publisher < RKit::ActiveRecordUtility::Base
+
+  instance_interferences 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
+
+  decorator_interferences do
+    def published_at
+      super().strftime "%a %e %b %Y"
+    end
+  end
+
+
+  def can_interfere?
+    base.table_exists? &&
+      base.column_names.include_all?(["published", "published_at"]) &&
+      base.columns_hash["published"].type == :boolean &&
+      base.columns_hash["published_at"].type == :datetime
+  end
+end

data/lib/r_kit/active_record_utility/base/series.rb

@@ -0,0 +1,141 @@
+class RKit::ActiveRecordUtility::Base::Series < RKit::ActiveRecordUtility::Base
+
+  instance_interferences do
+    has_one :followed, class_name: name, foreign_key: "following_id"
+    belongs_to :following, class_name: name
+
+    before_validation if: :following_id_changed? do
+      self.title ||= following.title if __class__.column_exists? "title"
+      self.series = following.series.name
+    end
+
+
+
+
+    # TODO: after save, if series change, all obj in series change
+
+    # TODO: we can add a conditionnal validation on 'inclusion_in' (like pool)
+
+    # TODO: validates presence of serie also on the followed record
+
+    # TODO: validates a record can only have one follower (or is it hadled by the "has_one" relation directly ?)
+
+    validates_presence_of :series, if: :following
+    validates_uniqueness_of :following_id, if: :following
+
+    scope :series, ->(series){ series && where(series: series) }
+
+    # TODO: adapter le scope pour intégrer les published (si interfered)
+    # je laisse en commentaire parceque j'aime pas le nom du scope,
+    # et j'ai pas d'idée là maintenant (à part 'pilotes', ou 'firsts')
+    # scope :firsts_of_series, ->{ where(following_id: nil) }
+
+    # TODO: scope pour l'ordre dans une serie (pour le decorator pagination_tag)
+
+    @@_active_record_utilities_series = {}
+  end
+
+  class_interferences 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
+      # maybe pre-calc this in after save
+    end
+
+    def series_struct
+      OpenStruct.new.tap do |series_struct|
+        series_struct.name = read_attribute :series
+        series_struct.collection = __class__.series series_struct.name
+        series_struct.size = series_struct.collection.count
+      end
+    end
+
+    def position_in_series
+      following ? following.send(__method__) + 1 : 1
+    end
+  end
+
+  decorator_interferences do
+    after_initialize do
+      # TODO: this can't stay this way, if "serie" is pre-calculated
+      # & shared accros instances & kept in memory (class variable)
+
+      # series.collection = series.collection.decorate if series
+      # TODO: infinite loop, need a "unless" on the after_init, or smthng even more smart
+      # ps: i'm not happy with this current decorate
+    end
+
+    def series_url
+      view.url_for [__class__, series: series.name]
+    end
+
+    def link_to_series
+      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
+      # 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
+      end
+
+      def showcase_title
+        "#{ __getobj__.title } <small><i class='no-warp'>(#{ series.size } vols)</i></small>".html_safe
+      end
+
+      def title options = {}
+        if series and false # and showcase
+          showcase_title
+        elsif series
+          series_title
+        else
+          super()
+        end
+      end
+    end
+
+    # TODO: put default locales keys ("vol" is hard coded here) in cluster
+    # same for the 'title' methods before
+    # TODO: the "disabled" link for self doesn't work yet
+    # in fact, the collection does not use the "self" object, so the singleton_class is lost
+    def pagination_tag
+      disable_pagination_link self
+      series.collection.decorate.map(&:pagination_link_to).reduce(:safe_concat)
+    end
+
+    def pagination_link_to
+      view.link_to "vol #{ position_in_series }", self, class: :btn
+    end
+
+    def disabled_pagination_link_to
+      view.content_tag :span, "vol #{ position_in_series }", class: :'btn-disabled'
+    end
+
+    def disable_pagination_link seriable_instance
+      class << seriable_instance
+        alias :pagination_link_to :disabled_pagination_link_to
+      end
+    end
+
+
+    # TODO: put default locales keys (:previous, :next) in cluster
+    def navigation_tag
+      view.content_tag :p do
+        safe_buffer = ActiveSupport::SafeBuffer.new
+        safe_buffer += view.link_to view.t(:previous), following, class: :btn if following
+        safe_buffer += " "
+        safe_buffer += view.link_to view.t(:next), followed, class: :btn if followed
+        safe_buffer
+      end
+    end
+  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/base/tag.rb

@@ -0,0 +1,17 @@
+class RKit::ActiveRecordUtility::Base::Tag < RKit::ActiveRecordUtility::Base
+
+  instance_interferences do
+    validates_presence_of :tag
+    validates_uniqueness_of :tag
+
+    def tagged(tag) find_by tag: tag end
+  end
+
+  class_interferences{ def to_param() tag end }
+
+  def can_interfere?
+    base.table_exists? &&
+      base.column_names.include?("tag") &&
+      base.columns_hash["tag"].type == :string
+  end
+end

data/lib/r_kit/active_record_utility/base.rb

@@ -0,0 +1,70 @@
+class RKit::ActiveRecordUtility::Base
+
+  attr_accessor :base, :method_name
+
+  def initialize base, method_name:;
+    @base = base
+    @method_name = method_name
+  end
+
+  def to_s
+    __class__.demodulize.underscore
+  end
+
+
+  def interfere *args
+    if can_interfere?
+      interfere! *args
+      interfered!
+    else
+      raise DatabaseSchemaError.new(base, method_name: method_name) unless running_script? /^rake db:/
+    end
+  end
+
+
+  # TODO: private/protected ?
+  def can_interfere?
+    raise NotImplementedError, 'Subclasses must implement this method'
+  end
+
+  def interfere! **options
+    base.interferences_options_set self, **options
+
+    base.instance_eval &instance_interferences
+    base.class_eval &class_interferences
+    base.decorator_klass.class_eval &decorator_interferences if base.decorator_klass
+  end
+
+  interferences = %i{instance class decorator}
+  interferences.each do |interference|
+    define_method "#{ interference }_interferences" do
+      __class__.send "#{ interference }_interferences_proc"
+    end
+
+    singleton_class.send :attr_reader, "#{ interference }_interferences_proc", default: proc{ Proc.new{} }
+
+    define_singleton_method "#{ interference }_interferences", ->(&block) do
+      instance_variable_set "@#{ interference }_interferences_proc", block
+    end
+  end
+
+
+  def interfered!
+    __class__.interfered base
+  end
+
+  class << self
+    def interfered? base
+      @interfered.include? base
+    end
+
+    def interfered base
+      @interfered << base
+    end
+
+    def inherited subclass
+      subclass.instance_variable_set :@interfered, []
+      super
+    end
+  end
+end

data/lib/r_kit/active_record_utility/database_schema_error.rb

@@ -1,9 +1,9 @@
 class DatabaseSchemaError < StandardError
-  def initialize base, method:;
+  def initialize base, method_name:;
     super %Q{
-WARNING - You tried to use the '#{ method }' DSL on '#{ base }',
-  You may want to create a 'tag' column first.
-  To do so, please refer to the 'RKit::ActiveRecordUtlity' documentation.
+WARNING - 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.
     }
   end
 end

data/lib/r_kit/active_record_utility.rb

@@ -1,15 +1,24 @@
 class RKit::ActiveRecordUtility
   dependency :utilities
 
-  load_path __FILE__, 'active_record_extend.rb'
+  load_path __FILE__, 'base.rb'
   load_path __FILE__, 'database_schema_error.rb'
-  load_path __FILE__, 'utility.rb'
+
+  load_path __FILE__, 'active_record_extend.rb'
+
 
   UTILITIES = {
+    pool: :acts_as_poolables,
+    publisher: :acts_as_publishables,
+    series: :acts_as_seriables,
     tag: :acts_as_taggables,
   }
 
+
+  config :all, true
+
   UTILITIES.each do |utility, _|
-    load_path __FILE__, "utility/#{ utility }.rb"
+    alias_config utility, :all
+    load_path __FILE__, "base/#{ utility }.rb", if: utility
   end
 end

data/lib/r_kit/backtrace.rb

@@ -1,5 +1,9 @@
 class RKit::Backtrace
 
+  # TODO: continuation is problematic with views
+  # 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'
 
 end

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

@@ -0,0 +1,26 @@
+class Dependency
+  attr_accessor :base, :service
+
+  def initialize base, service:;
+    @base = base
+    @service = RKit.const_get(service.to_s.classify)
+  end
+
+  def should_load?
+    !service.loaded?
+  end
+
+  # 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.
+    }
+    service.load
+  end
+
+  def load!
+    dependency! if should_load?
+  end
+end

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

@@ -0,0 +1,58 @@
+class LoadPath
+  attr_accessor :_base,
+    :file, :path, :priority, :conditions
+
+  def initialize base, file:, path:, priority: 1/0.0
+    @_base = base
+
+    @file = file
+    @path = path
+    @priority = priority
+  end
+
+
+  def extname
+    File.extname(file)
+  end
+
+  def fullpath
+    file.chomp! File.extname(file)
+    File.expand_path(path, file)
+  end
+
+
+  def should_load?
+    conditions.inject(true) do |should_load, (statement, condition)|
+      should_load && exec_condition(statement, condition)
+    end
+  end
+
+  def load_path!
+    require fullpath
+  end
+
+  def load!
+    load_path! if should_load?
+  end
+
+
+  def exec_condition statement, condition
+    condition = case condition
+    when Proc
+      condition.call _base::CONFIG
+    when Symbol, String
+      _base::CONFIG.send condition
+    end
+
+    exec_statement statement, condition
+  end
+
+  def exec_statement statement, condition
+    case statement
+    when :if
+      !!condition
+    when :unless
+      !condition
+    end
+  end
+end

data/lib/r_kit/core/loader.rb

@@ -28,15 +28,15 @@ class RKit::Core::Loader
   end
 
 
-  def load_path file, path, options = {}
-    load_path = LoadPath.new _base, file: file, path: path
+  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
   end
 
   def load_paths!
-    load_paths.each &:load!
+    load_paths.sort{ |a, b| a.priority <=> b.priority }.each &:load!
   end
 
 
@@ -51,90 +51,4 @@ class RKit::Core::Loader
     loaded!
   end
 
-
-  class LoadPath
-    attr_accessor :_base,
-      :file, :path, :conditions
-
-    def initialize base, file:, path:;
-      @_base = base
-
-      @file = file
-      @path = path
-    end
-
-
-    def extname
-      File.extname(file)
-    end
-
-    def fullpath
-      file.chomp! File.extname(file)
-      File.expand_path(path, file)
-    end
-
-
-    def should_load?
-      conditions.inject(true) do |should_load, (statement, condition)|
-        should_load && exec_condition(statement, condition)
-      end
-    end
-
-    def load_path!
-      require fullpath
-    end
-
-    def load!
-      load_path! if should_load?
-    end
-
-
-    def exec_condition statement, condition
-      condition = case condition
-      when Proc
-        condition.call _base::CONFIG
-      when Symbol, String
-        _base::CONFIG.send condition
-      end
-
-      exec_statement statement, condition
-    end
-
-    def exec_statement statement, condition
-      case statement
-      when :if
-        !!condition
-      when :unless
-        !condition
-      end
-    end
-  end
-
-
-  class Dependency
-    attr_accessor :base, :service
-
-    def initialize base, service:;
-      @base = base
-      @service = RKit.const_get(service.to_s.classify)
-    end
-
-    def should_load?
-      !RKit::Core::Loader.class_variable_get(:@@loaded).include? @service.name
-    end
-
-    def dependency!
-      warn %Q{
-WARNING - #{ @service.name } was implicitly loaded,
-  As a dependency for #{ base }.
-  You may want to load it explicitly.
-      }
-      @service.load
-    end
-
-    def load!
-      dependency! if should_load?
-    end
-  end
-
 end

data/lib/r_kit/core.rb

@@ -1,5 +1,9 @@
 class RKit::Core
 
+  # TODO: add a "warn" method, with a required 'if', that will display a warning msg if the condition is not fullfiled
+
+  # TODO: add a "description" method, wich will contain a descriptive text about the service
+
   class << self
     def init!
       @_config = Configurer.new self
@@ -23,6 +27,8 @@ class RKit::Core
     end
 
 
+    # TODO: define a method "config_get" that retreive the rkit config
+    # to do so, we will iterate throug the namespaces until we find somthing that inherit from RKit::Core
     delegate :config, :alias_config, :preset,
       to: :@_config
 
@@ -60,7 +66,11 @@ class RKit::Core
 
 
   require 'r_kit/core/configurer.rb'
+
   require 'r_kit/core/engineer.rb'
+
   require 'r_kit/core/loader.rb'
+  require 'r_kit/core/loader/dependency.rb'
+  require 'r_kit/core/loader/load_path.rb'
 
 end

data/lib/r_kit/css/lib/assets/stylesheets/r_kit/components/btn.scss

@@ -7,3 +7,11 @@
 	background-color: btn-background-color();
 	color: btn-color();
 }
+
+
+.btn-disabled{
+	@extend .btn;
+
+	background-color: btn-disabled-background-color();
+	color: btn-disabled-color();
+}

data/lib/r_kit/css/lib/assets/stylesheets/r_kit/components/pagination.scss

@@ -0,0 +1,3 @@
+.pagination{
+  @extend .text-center;
+}

data/lib/r_kit/css/lib/assets/stylesheets/r_kit/components.scss

@@ -1 +1,2 @@
 @import "components/btn";
+@import "components/pagination";

data/lib/r_kit/css/lib/assets/stylesheets/r_kit/variables/colors.scss

@@ -27,7 +27,7 @@ $text-info-color
 $text-muted-color
 */
 $background-color: background-color() !default;
-// $background-alt-color: #181818 !default;
+$background-alt-color: background-alt-color() !default;
 /*$background-success-color
 $background-warning-color
 $background-danger-color