pakyow-ui 0.11.3 → 1.0.0.rc1

data/lib/pakyow/ui/recordable.rb

@@ -0,0 +1,303 @@
+# frozen_string_literal: true
+
+require "json"
+
+require "pakyow/support/core_refinements/array/ensurable"
+
+require "pakyow/support/extension"
+require "pakyow/support/inflector"
+require "pakyow/support/safe_string"
+
+require "pakyow/data/sources/relational"
+
+require "pakyow/presenter/binding_parts"
+require "pakyow/presenter/versioned_view"
+require "pakyow/presenter/presenter"
+
+require "pakyow/ui/recordable/helpers/client_remapping"
+require "pakyow/ui/recordable/attributes"
+
+module Pakyow
+  module UI
+    module Recordable
+      extend Support::Extension
+
+      include Support::SafeStringHelpers
+
+      using Support::Refinements::Array::Ensurable
+
+      # @api private
+      attr_reader :calls
+
+      def to_json(*)
+        optimized.to_json
+      end
+
+      def to_a
+        @calls
+      end
+
+      # @api private
+      def cache_bindings!
+        binding_nodes = if (view.object.is_a?(StringDoc::Node) || view.object.is_a?(StringDoc::MetaNode)) && view.object.significant?(:multipart_binding)
+          [view.object]
+        else
+          view.object.find_significant_nodes(:binding)
+        end
+
+        @bindings = binding_nodes.flat_map { |node|
+          [node.label(:binding), node.label(:binding_prop)]
+        }.compact
+      end
+
+      private
+
+      def optimized
+        calls = []
+
+        # Combine finds when looking for the same nodes.
+        #
+        @calls.each do |call|
+          if call[0] == :find && matching_call = calls.find { |c| c[0] == :find && c[1] == call[1] && c[2] == call[2] }
+            matching_call[3].to_a.concat(call[3].to_a)
+          else
+            calls << call
+          end
+        end
+
+        # Prioritize the calls so they are applied correctly on the client.
+        #
+        calls.sort! { |a, b|
+          call_priority(a, calls) <=> call_priority(b, calls)
+        }
+
+        calls
+      end
+
+      PRIORITY_CALLS = %i(transform use).freeze
+
+      def call_priority(call, calls)
+        if PRIORITY_CALLS.include?(call[0])
+          # Set priority calls to a priority of -1000, which is highest priority.
+          #
+          -1000
+        elsif call[0] == :find
+          # Make priority of finds an inverse of specificity (e.g. [:post] > [:post, :title]).
+          #
+          -1000 + call[1][0].count
+        else
+          # Or just keep the same order we have now.
+          #
+          calls.index(call)
+        end
+      end
+
+      # FIXME: We currently viewify twice for present; once for transform, another for bind.
+      # Let's create a `Viewified` object instead... then check to see if it's already happened.
+      #
+      def viewify(data)
+        data = if data.is_a?(Data::Proxy)
+          data.to_a
+        elsif data.nil?
+          []
+        else
+          Array.ensure(data)
+        end
+
+        data.map { |object|
+          binder = wrap_data_in_binder(object)
+          object = binder.object
+
+          # Map object keys to the binding name.
+          #
+          keys_and_binding_names = object.to_h.keys.map { |key|
+            key = key.to_sym
+            if key == :id || @bindings.include?(key)
+              binding_name = key
+            else
+              plural_binding_name = Support.inflector.pluralize(key.to_s).to_sym
+              singular_binding_name = Support.inflector.singularize(key.to_s).to_sym
+
+              if @bindings.include?(plural_binding_name)
+                binding_name = plural_binding_name
+              elsif @bindings.include?(singular_binding_name)
+                binding_name = singular_binding_name
+              else
+                next
+              end
+            end
+
+            [key, binding_name]
+          }
+
+          # Add view-specific bindings that aren't in the object, but may exist in the binder.
+          #
+          @bindings.each do |binding_name|
+            unless keys_and_binding_names.find { |_, k2| k2 == binding_name }
+              keys_and_binding_names << [binding_name, binding_name]
+            end
+          end
+
+          viewified = keys_and_binding_names.compact.uniq.each_with_object({}) { |(key, binding_name), values|
+            value = binder.__value(key)
+
+            if value.is_a?(String)
+              value = ensure_html_safety(value)
+            end
+
+            if value.is_a?(Presenter::BindingParts)
+              values[binding_name] = value.values(@view.find(binding_name))
+            elsif !value.nil?
+              values[binding_name] = value
+            end
+          }
+
+          viewified
+        }
+      end
+
+      apply_extension do
+        include Helpers::ClientRemapping
+      end
+
+      def self.find_through(binding_path, binding_info, options, context, calls)
+        if binding_path.any?
+          binding_path_part = binding_path.shift
+          current_options = options.dup
+
+          if id = binding_info[binding_path_part.to_s.split(":", 2)[0].to_sym]
+            # Tie the transformations to a node of a specific id, unless we're transforming the entire set.
+            #
+            unless calls.any? { |call| call[0] == :transform }
+              current_options["id"] = id
+            end
+          end
+
+          subsequent = []
+
+          args = [[binding_path_part]]
+          unless current_options.empty?
+            args << current_options
+          end
+
+          context << [
+            :find,
+            args, [], subsequent
+          ]
+
+          find_through(binding_path, binding_info, options, subsequent, calls)
+        else
+          context.concat(calls)
+        end
+      end
+
+      class_methods do
+        def render_proc(view, render, &block)
+          super(view, render) do |_, context|
+            if render[:node]
+              instance_exec(&block)
+
+              # The super proc creates a new presenter instance per render, but we want each to use the
+              # same starting point for calls since they all apply to the same node.
+              #
+              context.calls.concat(calls)
+            else
+              instance_exec(&block)
+
+              if calls.any?
+                # Explicitly find the node to apply the transformation to the correct node. While
+                # we're at it, append any transformations caused by the `instance_exec` above.
+                #
+                Recordable.find_through(
+                  render[:binding_path].dup, object.label(:binding_info).to_h, {}, context.calls, calls
+                )
+              end
+            end
+          end
+        end
+
+        def from_presenter(presenter)
+          allocate.tap { |instance|
+            # Copy state from the presenter we're tracking.
+            #
+            presenter.instance_variables.each do |ivar|
+              instance.instance_variable_set(ivar, presenter.instance_variable_get(ivar))
+            end
+
+            instance.cache_bindings!
+          }
+        end
+      end
+
+      prepend_methods do
+        def initialize(*)
+          super
+
+          @calls = []
+          cache_bindings!
+        end
+
+        def presenter_for(view, type: view&.label(:presenter_type))
+          presenter = super
+
+          if presenter.is_a?(Delegator)
+            presenter.__setobj__(self.class.from_presenter(presenter.__getobj__))
+          else
+            presenter = self.class.from_presenter(presenter)
+          end
+
+          presenter
+        end
+
+        %i(
+          find transform use bind append prepend after before replace remove clear title= html=
+          endpoint endpoint_action component
+        ).each do |method_name|
+          define_method method_name do |*args, &block|
+            nested = []
+
+            super(*args) { |nested_presenter, *nested_args|
+              if block
+                nested << nested_presenter
+                block.call(nested_presenter, *nested_args)
+              end
+            }.tap do |result|
+              call_args = case method_name
+              when :find
+                # Because multiple bindings can be passed, we want to wrap them in
+                # an array so that the client sees them as a single argument.
+                #
+                [args]
+              when :transform
+                # Ignore the potential `yield_block` argument that's used internally.
+                #
+                [viewify(args[0])]
+              when :bind
+                # Modify the bound data to include only necessary values.
+                #
+                viewify(args)
+              else
+                args
+              end
+
+              subsequent = if (result.is_a?(Presenter::Presenter) && !result.equal?(self)) || (result.is_a?(Delegator) && !result.__getobj__.equal?(self)) || result.is_a?(Attributes)
+                result
+              else
+                []
+              end
+
+              calls << [remap_for_client(method_name), call_args, nested, subsequent]
+            end
+          end
+        end
+
+        def attributes
+          Attributes.from_attributes(super).tap do |subsequent|
+            calls << [:attributes, [], [], subsequent]
+          end
+        end
+        alias attrs attributes
+      end
+    end
+  end
+end

data/lib/pakyow/ui.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "pakyow/support"
+require "pakyow/routing"
+require "pakyow/data"
+require "pakyow/presenter"
+require "pakyow/realtime"
+
+require "pakyow/ui/framework"

metadata

@@ -1,155 +1,141 @@
 --- !ruby/object:Gem::Specification
 name: pakyow-ui
 version: !ruby/object:Gem::Version
-  version: 0.11.3
+  version: 1.0.0.rc1
 platform: ruby
 authors:
 - Bryan Powell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-15 00:00:00.000000000 Z
+date: 2019-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: pakyow-support
+  name: pakyow-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.11.3
+        version: 1.0.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.11.3
+        version: 1.0.0.rc1
 - !ruby/object:Gem::Dependency
-  name: pakyow-core
+  name: pakyow-data
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.11.3
+        version: 1.0.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.11.3
+        version: 1.0.0.rc1
 - !ruby/object:Gem::Dependency
   name: pakyow-presenter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.11.3
+        version: 1.0.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.11.3
+        version: 1.0.0.rc1
 - !ruby/object:Gem::Dependency
   name: pakyow-realtime
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.11.3
+        version: 1.0.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.11.3
+        version: 1.0.0.rc1
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: pakyow-routing
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '5.6'
-  type: :development
+        version: 1.0.0.rc1
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '5.6'
+        version: 1.0.0.rc1
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pakyow-support
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3.2'
-  type: :development
+        version: 1.0.0.rc1
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 1.0.0.rc1
 description: Auto-Updating UIs for Pakyow
 email: bryan@metabahn.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- pakyow-ui/CHANGELOG.md
-- pakyow-ui/LICENSE
-- pakyow-ui/README.md
-- pakyow-ui/lib/pakyow-ui.rb
-- pakyow-ui/lib/pakyow/ui.rb
-- pakyow-ui/lib/pakyow/ui/base.rb
-- pakyow-ui/lib/pakyow/ui/channel_builder.rb
-- pakyow-ui/lib/pakyow/ui/config.rb
-- pakyow-ui/lib/pakyow/ui/ext/app.rb
-- pakyow-ui/lib/pakyow/ui/ext/view_context.rb
-- pakyow-ui/lib/pakyow/ui/fetch_view_handler.rb
-- pakyow-ui/lib/pakyow/ui/helpers.rb
-- pakyow-ui/lib/pakyow/ui/mock_mutation_eval.rb
-- pakyow-ui/lib/pakyow/ui/mutable.rb
-- pakyow-ui/lib/pakyow/ui/mutable_data.rb
-- pakyow-ui/lib/pakyow/ui/mutate_context.rb
-- pakyow-ui/lib/pakyow/ui/mutation_set.rb
-- pakyow-ui/lib/pakyow/ui/mutation_store.rb
-- pakyow-ui/lib/pakyow/ui/mutator.rb
-- pakyow-ui/lib/pakyow/ui/no_op_view.rb
-- pakyow-ui/lib/pakyow/ui/registries/redis_mutation_registry.rb
-- pakyow-ui/lib/pakyow/ui/registries/simple_mutation_registry.rb
-- pakyow-ui/lib/pakyow/ui/ui.rb
-- pakyow-ui/lib/pakyow/ui/ui_attrs.rb
-- pakyow-ui/lib/pakyow/ui/ui_component.rb
-- pakyow-ui/lib/pakyow/ui/ui_context.rb
-- pakyow-ui/lib/pakyow/ui/ui_instructable.rb
-- pakyow-ui/lib/pakyow/ui/ui_request.rb
-- pakyow-ui/lib/pakyow/ui/ui_view.rb
-homepage: http://pakyow.org
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/pakyow/ui.rb
+- lib/pakyow/ui/behavior/recording.rb
+- lib/pakyow/ui/behavior/rendering.rb
+- lib/pakyow/ui/behavior/rendering/install_transforms.rb
+- lib/pakyow/ui/behavior/timeouts.rb
+- lib/pakyow/ui/framework.rb
+- lib/pakyow/ui/handler.rb
+- lib/pakyow/ui/helpers.rb
+- lib/pakyow/ui/recordable.rb
+- lib/pakyow/ui/recordable/attribute.rb
+- lib/pakyow/ui/recordable/attributes.rb
+- lib/pakyow/ui/recordable/helpers/client_remapping.rb
+homepage: https://pakyow.org
 licenses:
-- MIT
+- LGPL-3.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
-- pakyow-ui/lib
+- lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Pakyow UI

data/pakyow-ui/LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) 2015 Bryan Powell
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/pakyow-ui/lib/pakyow/ui/base.rb

@@ -1,26 +0,0 @@
-require_relative 'helpers'
-require_relative 'ui'
-require_relative 'mutator'
-require_relative 'mutation_set'
-require_relative 'mutable'
-require_relative 'mutate_context'
-require_relative 'ui_view'
-require_relative 'channel_builder'
-require_relative 'fetch_view_handler'
-require_relative 'mutation_store'
-require_relative 'registries/simple_mutation_registry'
-require_relative 'registries/redis_mutation_registry'
-require_relative 'config'
-require_relative 'ui_component'
-require_relative 'ui_instructable'
-
-require_relative 'ext/app'
-require_relative 'ext/view_context'
-
-Pakyow::App.before :init do
-  @ui = Pakyow::UI::UI.new
-end
-
-Pakyow::App.after :load do
-  @ui.load(mutators, mutables)
-end

data/pakyow-ui/lib/pakyow/ui/channel_builder.rb

@@ -1,55 +0,0 @@
-module Pakyow
-  module UI
-    # Helpers for building channel names.
-    #
-    # @api private
-    module ChannelBuilder
-      PARTS = [:scope, :mutation, :component]
-
-      def self.build(qualifiers: [], data: [], qualifications: {}, **args)
-        channel = []
-        channel_extras = []
-
-        PARTS.each do |part|
-          add_part(part, args[part], channel)
-        end
-
-        add_qualifiers(qualifiers, data, channel_extras)
-        add_qualifications(qualifications, channel_extras)
-
-        channel = channel.join(';')
-
-        return channel if channel_extras.empty?
-        channel << "::#{channel_extras.join(';')}"
-      end
-
-      private
-
-      def self.add_part(part, value, channel)
-        return if value.nil?
-        channel << "#{part}:#{value}"
-      end
-
-      def self.add_qualifiers(qualifiers, data, channel_extras)
-        qualifiers = Array.ensure(qualifiers)
-
-        data = data.data if data.is_a?(Pakyow::UI::MutableData)
-        data = Array.ensure(data).compact
-        return if qualifiers.empty? || data.empty?
-
-        datum = data.first
-
-        qualifiers.each do |qualifier|
-          channel_extras << "#{qualifier}:#{datum[qualifier.to_sym]}"
-        end
-      end
-
-      def self.add_qualifications(qualifications, channel_extras)
-        qualifications.each do |name, value|
-          next if value.nil?
-          channel_extras << "#{name}:#{value}"
-        end
-      end
-    end
-  end
-end

data/pakyow-ui/lib/pakyow/ui/config.rb

@@ -1,11 +0,0 @@
-require_relative 'registries/simple_mutation_registry'
-require_relative 'registries/redis_mutation_registry'
-
-Pakyow::Config.register :ui do |config|
-  # The registry to use when keeping up with connections.
-  config.opt :registry, Pakyow::UI::SimpleMutationRegistry
-end.env :development do |opts|
-  opts.registry = Pakyow::UI::SimpleMutationRegistry
-end.env :production do |opts|
-  opts.registry = Pakyow::UI::RedisMutationRegistry
-end

data/pakyow-ui/lib/pakyow/ui/ext/app.rb

@@ -1,52 +0,0 @@
-module Pakyow
-  class App
-    attr_reader :ui
-
-    class << self
-      # Defines mutators for a scope.
-      #
-      # @api public
-      def mutators(scope = nil, &block)
-        @mutators ||= {}
-
-        if scope && block
-          @mutators[scope] = block
-        else
-          @mutators || {}
-        end
-      end
-
-      # Defines a mutable object.
-      #
-      # @api public
-      def mutable(scope, &block)
-        @mutables ||= {}
-        @mutables[scope] = block
-      end
-
-      # @api private
-      def mutables
-        @mutables || {}
-      end
-    end
-
-    # Convenience method for defining mutators on an app instance.
-    #
-    # @api public
-    def mutators(scope = nil, &block)
-      self.class.mutators(scope, &block)
-    end
-
-    # Convenience method for defining a mutable on an app instance.
-    #
-    # @api public
-    def mutable(scope, &block)
-      self.class.mutable(scope, &block)
-    end
-
-    # @api private
-    def mutables
-      self.class.mutables
-    end
-  end
-end