tram-page 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2da2c8691b77724f4c2cf404654c5ef1a3c7e574
-  data.tar.gz: a4ad045bf0497258617b20ce47b0dfabf8e399fd
+  metadata.gz: b03850fffdac958f2626d16b333e0a15439ee498
+  data.tar.gz: 185226f1ed9ddbdb0c26b3bf1837fd741bbfb8bc
 SHA512:
-  metadata.gz: 1019255dafb0500aa25040e48786b1463de3d0e514f63144fec24e5705128977f39137a547e21af8be92ca54c5df772bc6dbaa2ed13b035e34814cc1ae5c49dc
-  data.tar.gz: fde7d0cc7d8a5c7b8661931fd248bb4e55f6282ed8cca52c8b789c6176212b7d214241fba779ac0c7719a40b37d8f2f78b92306a9f9eeedea74450d376676b99
+  metadata.gz: 5880b0e19b2b71db67a45e26329ad58ba4dd4d708ad8b909a6f2af07bb7e0e1c2dda1dab8b3d10412f157e5d96fac31b3427bfec48b9e094730b101d27dfa897
+  data.tar.gz: d4836017f4f9a69322f78d7d8fef248fe57b95599457e362600e3d00dd3ca2ffb8029dd2ebe7d54fa4e7ecb2bc1a45f6f1103dc9646d685af10e9a19e1eeabd3

data/lib/tram/page.rb

@@ -1,67 +1,77 @@
 # frozen_string_literal: true
 
 class Tram::Page
-  extend ::Dry::Initializer::Mixin
+  extend ::Dry::Initializer
+
+  require_relative "page/section"
 
   class << self
     attr_accessor :i18n_scope
 
-    def section(name, options = {})
-      @__sections ||= []
+    # Defines a section of the page as a reference to its public method,
+    # and creates/overloads the method if necessary.
+    #
+    # @param  [#to_sym] name The name of the **section**
+    #
+    # @option [Boolean] :overload
+    #   If this definition can overload a previous one
+    # @option [Proc] :value (nil)
+    #   A new content of the referred method
+    # @option options [#to_sym] :method (name)
+    #   The name of public method to take value from
+    # @option options [#to_sym] :if (nil)
+    #   The name of public method to check if the section should be displayed
+    # @option options [#to_sym] :unless (nil)
+    #   The name of public method to check if the section should be hidden
+    #
+    # @return [self] itself
+    #
+    def section(name, overload: false, value: nil, **options)
+      name = name.to_sym
+      raise "Section #{name} already exists" if !overload && sections.key?(name)
 
-      n = name.to_sym
-      if @__sections.map(&:first).include?(n)
-        raise "Section #{n} already exists"
-      end
+      section = Section.new(name, options)
+      define_method(section.source, &value) if value
 
-      n = define_section_method(n, options)
-      @__sections << [n, options]
+      sections[name] = section
+      self
     end
 
+    # Makes Rails url helper method accessible from within a page instance
+    #
+    # @param [#to_s] name The name of the helper method
+    #
+    # @return [self] itself
+    #
     def url_helper(name)
       raise "Rails url_helpers module is not defined" unless defined?(Rails)
       delegate name, to: :"Rails.application.routes.url_helpers"
+      self
     end
 
-    private
-
-    def define_section_method(n, options)
-      return n unless options[:value]
-      define_method(n) { instance_exec(&options[:value]) }
-      n
+    # The hash of definitions for the page's sections
+    #
+    # @return [Hash]
+    #
+    def sections
+      @sections ||= {}
     end
   end
 
-  def to_h(options = {})
-    data = page_methods(options).map do |(name, opts)|
-      value = public_send(opts[:method] || name)
-      [name, value]
-    end
-    Hash[data]
+  def to_h(except: nil, only: nil, **)
+    sections = self.class.sections.dup
+    sections.select! { |k, _| Array(only).include? k }   if only
+    sections.reject! { |k, _| Array(except).include? k } if except
+    sections.map { |_, section| section.call(self) }.reduce({}, :merge!)
   end
 
   private
 
-  def t(key)
+  def t(key, **options)
     raise "I18n is not defined" unless defined?(I18n)
-    I18n.t key, scope: [Tram::Page.i18n_scope, self.class.name.underscore]
-  end
-
-  def page_methods(options)
-    methods = self.class.instance_variable_get(:"@__sections") || []
-    except = Array(options[:except])
-    only = Array(options[:only])
-    methods.reject do |(name, opts)|
-      (except.any? && except.include?(name)) ||
-        (only.any? && !only.include?(name)) ||
-        __hide?(opts)
-    end
+    default_scope = [Tram::Page.i18n_scope, self.class.name.underscore]
+    I18n.t key, scope: default_scope, **options
   end
 
-  def __hide?(opts)
-    black, white = opts.values_at(:unless, :if)
-    (black && public_send(black)) || (white && !public_send(white))
-  end
+  self.i18n_scope = "pages"
 end
-
-Tram::Page.i18n_scope = "pages"

data/lib/tram/page/section.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+class Tram::Page
+  #
+  # @private
+  # Contains class-level definition (name and options) for a section
+  # with a method [#call] that extracts the section part of hash
+  # from an instance of [Tram::Page]
+  #
+  class Section
+    extend Dry::Initializer
+    param  :name,   proc(&:to_sym)
+    option :method, proc(&:to_s), default: -> { name }, as: :source
+    option :if,     proc(&:to_s), optional: true,       as: :positive
+    option :unless, proc(&:to_s), optional: true,       as: :negative
+
+    # @param  [Tram::Page] page
+    # @return [Hash] a part of the section
+    def call(page)
+      skip_on?(page) ? {} : { name => value_at(page) }
+    end
+
+    private
+
+    def skip_on?(page)
+      return true if positive && !page.public_send(positive)
+      return true if negative &&  page.public_send(negative)
+    end
+
+    def value_at(page)
+      page.public_send(source)
+    end
+  end
+end

data/lib/tram/page/version.rb

@@ -3,6 +3,6 @@
 # rubocop:disable Style/ClassAndModuleChildren
 module Tram
   class Page
-    VERSION = "0.1.4"
+    VERSION = "0.1.5"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tram-page
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Viktor Sokolov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-17 00:00:00.000000000 Z
+date: 2018-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -99,6 +99,7 @@ files:
 - bin/console
 - bin/setup
 - lib/tram/page.rb
+- lib/tram/page/section.rb
 - lib/tram/page/version.rb
 - tram-page.gemspec
 homepage: https://github.com/tram-rb/tram-page
@@ -122,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Page Object pattern