voom-presenters 0.2.0 → 2.0.0

data/lib/voom/presenters/dsl/components/typography.rb

@@ -1,6 +1,3 @@
-require 'voom/presenters/dsl/components/mixins/event'
-require 'voom/presenters/dsl/components/mixins/tooltips'
-
 module Voom
   module Presenters
     module DSL
@@ -8,14 +5,16 @@ module Voom
         class Typography < EventBase
           include Mixins::Tooltips
 
-          attr_accessor :text, :level, :color, :position
+          attr_accessor :text, :level, :color, :position, :inline, :markdown
 
           def initialize(parent:, level: nil, **attribs_, &block)
             super(type: :text, parent: parent, **attribs_, &block)
             @text = Array(attribs.delete(:text)||'').flatten.join("\n\n").split("\n\n")
             @level = level
             @color = attribs.delete(:color)
+            @inline = attribs.delete(:inline) { false }
             @position = Array(attribs.delete(:position)).compact
+            @markdown = attribs.delete(:markdown) { true }
             expand!
           end
 
@@ -24,6 +23,7 @@ module Voom
             @icon = Components::Icon.new(parent: self, icon: icon,
                                          **attribs, &block)
           end
+
         end
       end
     end

data/lib/voom/presenters/dsl/components/unordered_list.rb

@@ -0,0 +1,50 @@
+module Voom
+  module Presenters
+    module DSL
+      module Components
+        class UnorderedList < Base
+
+          attr_reader :list_items, :list_style
+
+          def initialize(**attribs_, &block)
+            super(type: :unordered_list, **attribs_, &block)
+            @list_style = attribs.delete(:list_style){ :disc }
+            @list_items = []
+            expand!
+          end
+
+          def list_item(text=nil, **attribs_, &block)
+            @list_items << ListItem.new(parent: self, text: text, **attribs_, &block)
+          end
+
+          class ListItem < Base
+
+            def initialize(**attribs_, &block)
+              super(type: :list_item, **attribs_, &block)
+              self.text(attribs.delete(:text)) if attribs.key?(:text)
+              self.icon(attribs.delete(:icon)) if attribs.key?(:icon)
+              self.unordered_list(attribs.delete(:unordered_list)) if attribs.key?(:unordered_list)
+              expand!
+            end
+
+            def text(*text, **attribs, &block)
+              return @text if locked?
+              @text = Components::Typography.new(parent: self, type: :text, text: text, **attribs, &block)
+            end
+
+            def icon(icon=nil, **attribs, &block)
+              return @icon if locked?
+              @icon = Components::Icon.new(parent: self, icon: icon, **attribs, &block)
+            end
+
+            def unordered_list(**attribs, &block)
+              return @unordered_list if locked?
+              @unordered_list = UnorderedList.new(parent: self, **attribs, &block)
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/voom/presenters/dsl/definer.rb

@@ -1,7 +1,3 @@
-require 'voom/presenters/dsl/components/base'
-require 'voom/presenters/dsl/components/event_base'
-Dir[__dir__ + "/components/*.rb"].each {|file| require file }
-
 module Voom
   module Presenters
     module DSL

data/lib/voom/presenters/dsl/definition.rb

@@ -1,5 +1,3 @@
-require 'voom/presenters/dsl/user_interface'
-
 module Voom
   module Presenters
     module DSL
@@ -7,9 +5,12 @@ module Voom
       # This class is held in the container. When a request to render a UI comes in
       # It creates a new UserInterface instance, binding it to the router and context of the request
       class Definition
-        def initialize(namespace, &block)
+        attr_reader :name, :namespace, :options
+        def initialize(name, namespace, options, &block)
           @block = block
+          @name = name
           @namespace = namespace
+          @options = options
         end
 
         def build
@@ -17,7 +18,7 @@ module Voom
         end
 
         def expand(router: , context:{}, &block)
-          presenter = UserInterface.new(router: router, context: context,  namespace: @namespace, &@block)
+          presenter = UserInterface.new(router: router, context: context,  name: @name, namespace: @namespace, &@block)
           yield(presenter) if block
           presenter.expand_instance
         end
@@ -30,4 +31,4 @@ module Voom
       end
     end
   end
-end
+end

data/lib/voom/presenters/dsl/protect_from_forgery.rb

@@ -0,0 +1,43 @@
+require 'base64'
+
+module Voom
+  module Presenters
+    module DSL
+      module ProtectFromForgery
+        include Base64
+
+        AUTHENTICITY_TOKEN_LENGTH = 32
+
+        def authenticity_token_meta_tags(session)
+          return unless Presenters::Settings.config.presenters.web_client.protect_from_forgery && session
+          [
+              '<meta name="csrf-param" content="authenticity_token">',
+              "<meta name=\"csrf-token\" content=\"#{form_authenticity_token(session)}\">"
+          ].join("\n").html_safe
+        end
+
+        def form_authenticity_token(session)
+          session[:_csrf_token] ||= SecureRandom.base64(AUTHENTICITY_TOKEN_LENGTH)
+          raw_token = Base64.strict_decode64(session[:_csrf_token])
+          one_time_pad = SecureRandom.random_bytes(AUTHENTICITY_TOKEN_LENGTH)
+          encrypted_csrf_token = xor_byte_strings(one_time_pad, raw_token)
+          masked_token = one_time_pad + encrypted_csrf_token
+          Base64.strict_encode64(masked_token)
+        end
+
+
+        def xor_byte_strings(s1, s2) # :doc:
+          s2 = s2.dup
+          size = s1.bytesize
+          i = 0
+          while i < size
+            s2.setbyte(i, s1.getbyte(i) ^ s2.getbyte(i))
+            i += 1
+          end
+          s2
+        end
+
+      end
+    end
+  end
+end

data/lib/voom/presenters/dsl/user_interface.rb

@@ -1,23 +1,11 @@
 require 'ice_nine'
-require 'voom/presenters/dsl/definer'
-require 'voom/presenters/dsl/components/mixins/common'
-require 'voom/presenters/dsl/components/mixins/helpers'
-require 'voom/presenters/dsl/components/mixins/dialogs'
-require 'voom/presenters/dsl/components/mixins/snackbars'
-require 'voom/presenters/dsl/components/mixins/text_fields'
-require 'voom/presenters/dsl/components/mixins/date_time_fields'
-require 'voom/presenters/dsl/components/mixins/attaches'
-require 'voom/presenters/dsl/invalid_presenter'
-
-require 'voom/serializer'
-require 'voom/trace'
-
 
 module Voom
   module Presenters
     module DSL
       class UserInterface
         include DSL::Definer
+        include DSL::ProtectFromForgery
         include Components::Mixins::Common
         include Components::Mixins::Helpers
         include Components::Mixins::Dialogs
@@ -26,52 +14,62 @@ module Voom
         include Components::Mixins::TextFields
         include Components::Mixins::DateTimeFields
         include Components::Mixins::Attaches
+        include Components::Mixins::Event
+        extend Pluggable
+        include_plugins(:DSLComponents, :DSLHelpers)
 
         include Voom::Serializer
         include Voom::Trace
 
-        attr_reader :router, :context, :components, :namespace
+        attr_reader :router, :context, :components, :name, :namespace
         private :context, :router, :namespace
         alias params context
 
-        def initialize(context:, parent: nil, router: nil, namespace: [], &block)
+        def initialize(context:, parent: nil, router: nil, name: nil, namespace: [], &block)
           @parent = parent
           @router = router || @parent&.send(:router)
-          @context = context
+          @context = context || {}
           @block = block
           @header = nil
           @drawer = nil
           @components = []
           @footer = nil
+          @name = name
           @namespace = namespace
+          @plugins = []
+          @csrf_meta_tags = authenticity_token_meta_tags(@context.fetch(:session, nil))
           add_global_helpers
+          initialize_plugins
         end
 
-        def page(title=nil, **attribs, &block)
+        def page(title = nil, **attribs, &block)
           return @page if locked?
           @page = Components::Page.new(parent: self, **attribs, &block)
         end
 
-        def header(title=nil, **attribs, &block)
+        def header(title = nil, **attribs, &block)
           return @header if locked?
           @header = Components::Header.new(parent: self, title: title,
                                            **attribs, &block)
         end
 
-        def drawer(name=nil, **attribs, &block)
+        def drawer(name = nil, **attribs, &block)
           return @drawer if locked?
           @drawer = Components::Drawer.new(parent: self, title: name,
                                            **attribs, &block)
         end
 
 
-
         def footer(**attribs, &block)
           return @footer if locked?
           @footer = Components::Footer.new(parent: self,
                                            **attribs, &block)
         end
 
+        def progress(**attributes, &block)
+          self << Components::Progress.new(parent: self, **attributes, &block)
+        end
+
         def attach(presenter, **params, &yield_block)
           pom = super
           @header ||= pom.header
@@ -100,6 +98,21 @@ module Voom
           :presenter
         end
 
+        def plugin(*plugin_names)
+          @plugins.push(*plugin_names)
+          self.class.include_plugins(:DSLComponents, :DSLHelpers, plugins: plugin_names)
+        end
+
+        def plugins
+          return @plugins if locked?
+          return @plugins if @plugins
+        end
+        alias _plugins_ plugins
+
+        def csrf_meta_tags
+          Presenters::Settings.config.presenters.web_client.protect_from_forgery ? @csrf_meta_tags : nil
+        end
+
         private
 
         def deep_freeze
@@ -107,8 +120,6 @@ module Voom
           self
         end
 
-        private
-
         def parent(for_type)
           nil
         end
@@ -128,6 +139,10 @@ module Voom
           end
         end
 
+        def initialize_plugins
+          self.class.include_plugins(:DSLComponents, :DSLHelpers, plugins: @plugins)
+        end
+
         def lock!
           @locked = true
         end

data/lib/voom/presenters/errors.rb

@@ -0,0 +1 @@
+Dir[File.join(__dir__, 'errors', '*.rb')].each { |file| require file }

data/lib/voom/presenters/errors/invalid_dsl.rb

@@ -0,0 +1,8 @@
+module Voom
+  module Presenters
+    module Errors
+      class InvalidDsl < StandardError
+      end
+    end
+  end
+end

data/lib/voom/presenters/errors/parameter_validation.rb

@@ -1,5 +1,3 @@
-require 'voom/presenters/errors/unprocessable'
-
 module Voom
   module Presenters
     module Errors
@@ -7,4 +5,4 @@ module Voom
       end
     end
   end
-end
+end

data/lib/voom/presenters/generators/inflectors.rb

@@ -0,0 +1,59 @@
+module Voom
+  module Presenters
+    module Generators
+      module Inflectors
+        def classify(input)
+          # "books" => "Book"
+          @inflector.classify(input)
+        end
+
+        def pluralize(input)
+          #book" => "books"
+          @inflector.pluralize(input)
+        end
+
+        def singularize(input)
+          #"books" => "book"
+          @inflector.singularize(input)
+        end
+
+        def camelize(input)
+          # "dry/inflector" => "Dry::Inflector"
+          @inflector.camelize(input)
+        end
+
+        def tableize(input)
+          # "Book" => "books"
+          @inflector.tableize(input)
+        end
+
+        def dasherize(input)
+          # "dry_inflector" => "dry-inflector"
+          @inflector.dasherize(input)
+        end
+
+        def underscore(input)
+          # "dry-inflector" => "dry_inflector"
+          @inflector.underscore(input)
+        end
+
+        def demodulize(input)
+          # "Dry::Inflector"  => "Inflector"
+          @inflector.demodulize(input)
+        end
+
+        def humanize(input)
+          # "dry_inflector"  => "Dry inflector", "author_id" => "Author"
+          @inflector.humanize(input)
+        end
+
+        def ordinalize(input)
+          # 1 => "1st
+          @inflector.ordinalize(input)
+        end
+
+      end
+    end
+  end
+end
+

data/lib/voom/presenters/generators/plugin.rb

@@ -0,0 +1,115 @@
+require "dry/inflector"
+require_relative 'inflectors'
+
+module Voom
+  module Presenters
+    module Generators
+      class Plugin < ::Thor::Group
+        TEMPLATES_ROOT = File.join('templates','plugin')
+        LIB_ROOT = File.join('lib','voom','presenters','plugins')
+        include Thor::Actions
+        argument :name
+
+        def initialize(args = [], local_options = {}, config = {})
+          @inflector = Dry::Inflector.new
+          super
+        end
+
+        def self.source_root
+          File.dirname(__FILE__)
+        end
+
+        no_tasks do
+          include Voom::Presenters::Generators::Inflectors
+
+          def join_path(*parts)
+            File.join(*parts.compact)
+          end
+
+          def template_file(template, target_filename=template, source_path=nil, target_path=source_path)
+            underscore_name = underscored_name
+            source = join_path(TEMPLATES_ROOT, source_path, "#{template}.tt")
+            destination = join_path(underscore_name, target_path, target_filename)
+            template source, destination
+          end
+
+          def file(file, target_filename=file, source_path=nil, target_path=nil)
+            underscore_name = underscored_name
+            source = join_path(TEMPLATES_ROOT, source_path, file)
+            destination = join_path(underscore_name, target_path, target_filename)
+
+            copy_file source, destination
+          end
+
+          def lib_dir(*args)
+            dir(LIB_ROOT, *args)
+          end
+
+          def dir(*args)
+            join_path(*args)
+          end
+          
+          def named_dir(*args)
+            lib_dir(underscored_name, *args)
+          end
+          
+          def underscored_name
+            underscore(name)
+          end
+        end
+
+        def create_root_files
+          file('.gitignore')
+          file('Gemfile')
+          template_file('LICENSE.txt')
+          template_file('presenter_plugin.gemspec', "#{underscored_name}_presenter_plugin.gemspec")
+          file 'README.md'
+        end
+
+        def create_plugin
+          template_file('plugin.rb', "#{underscored_name}.rb", LIB_ROOT)
+        end
+
+        def create_component_files
+          template_file('component.rb', "#{underscored_name}_component.rb",
+                        lib_dir('components'),
+                        named_dir('components'))
+          template_file('dsl.rb', "#{underscored_name}_dsl.rb",
+                        lib_dir('components'),
+                        named_dir('components'))
+          template_file('render.rb', "#{underscored_name}_render.rb",
+                        lib_dir('web_client', 'components'),
+                        named_dir('web_client', 'components'))
+          template_file('component.css', "#{underscored_name}.css",
+                        dir('views', 'assets', 'css', 'components'))
+          template_file('component.js', "#{underscored_name}.js",
+                        dir('views', 'assets', 'js', 'components'))
+          template_file('component.erb', "#{underscored_name}.erb",
+                        dir('views', 'components'))
+          template_file('component_header.erb', "#{underscored_name}_header.erb",
+                        dir('views', 'components'))
+        end
+
+        def create_action_files
+          template_file('action.rb', "#{underscored_name}_action.rb",
+                        lib_dir('components', 'actions'),
+                        named_dir('components', 'actions'))
+          template_file('dsl.rb', "#{underscored_name}_dsl.rb",
+                        lib_dir('components', 'actions'),
+                        named_dir('components', 'actions'))
+          template_file('data.rb', "#{underscored_name}_data.rb",
+                        lib_dir('web_client', 'components', 'actions'),
+                        named_dir('web_client', 'components', 'actions'))
+          template_file('action.js', "#{underscored_name}.js",
+                        dir('views', 'assets', 'js', 'components', 'actions'))
+        end
+
+        def create_helper_files
+          template_file('helper.rb', "#{underscored_name}_helper.rb",
+                        lib_dir('helpers'),
+                        named_dir('helpers'))
+        end
+      end
+    end
+  end
+end