voom-presenters 0.1.0

data/lib/voom/presenters/demo/search-terms.yml

@@ -0,0 +1,50 @@
+characters: [ "Richard Hendricks", "Erlich Bachman", "Nelson \"Big Head\" Bighetti", "Bertram Gilfoyle", "Dinesh Chugtai", "Monica Hall", "Donald \"Jared\" Dunn", "Gavin Belson", "Jian Yang", "Laurie Bream", "Russ Hanneman", "Jack \"Action Jack\" Barker", "Keenan Feldspar", "Ed Chen", "Peter Gregory", "Ron LaFlamme" ]
+companies: [ "Pied Piper", "Hooli", "Raviga Capital Management", "Endframe", "Bachmanity", "Maleant Data Systems Solutions", "Aviato", "Coleman-Blair", "Raviga", "Yoyodyne", "Intersite", "Infotrode", "Bream-Hall", "SeeFood Technologies Inc", "Retinabyte", "VidClone Graphics", "Entercross Systems", "Turnwire" ]
+quotes: [
+  "I don't want to live in a world where someone else is making the world a better place better than we are.",
+  "I firmly believe we can only achieve greatness if first, we achieve goodness",
+  "Line ’em up, nuts to butts",
+  "Let me ask you. How fast do you think you could jerk off every guy in this room? Because I know how long it would take me. And I can prove it",
+  "It's weird. They always travel in groups of five. These programmers, there's always a tall, skinny white guy; short, skinny Asian guy; fat guy with a ponytail; some guy with crazy facial hair; and then an East Indian guy. It's like they trade guys until they all have the right group.",
+  "Jian-Yang, what're you doing? This is Palo Alto. People are lunatics about smoking here. We don't enjoy all the freedoms that you have in China.",
+  "Well, you just brought piss to a shit fight, you little cunt!",
+  "Hitler actually played the bassoon. So technically Hitler was the Hitler of music.",
+  "I simply imagine that my skeleton is me and my body is my house. That way I'm always home.",
+  "Gavin Belson started out with lofty goals too, but he just kept excusing immoral behavior just like this, until one day all that was left was a sad man with funny shoes... Disgraced, friendless, and engorged with the blood of a youthful charlatan.",
+  "And that, gentlemen, is scrum. Welcome to the next eight weeks of our lives.",
+  "Of course they know that you're not pitching Shazam. That already exists. This would be a Shazam... for food.",
+  "Compromise is the shared hypotenuse of the conjoined triangles of success.",
+  "Gentlemen, I just paid the palapa contractor. The palapa piper, so to speak. The dream is a reality. We'll no longer be exposed... to the elements.",
+  "I was gonna sleep last night, but, uh... I thought I had this solve for this computational trust issue I've been working on, but it turns out, I didn't have a solve. But it was too late. I had already drank the whole pot of coffee.",
+  "I extended my compression algorithm to support... get this... 12-bit color. Okay, so our users will be able to experience a 10 percent increase in image quality with absolutely no increase in server load whatsoever. Just-Just-Just... Just watch this. Before. After. Before. After.",
+  "You listen to me, you muscle-bound handsome Adonis: tech is reserved for people like me, okay? The freaks, the weirdos, the misfits, the geeks, the dweebs, the dorks! Not you!"
+]
+apps: [ "Nip Alert", "Astraphile", "Panic-a-Tech", "Spinder", "Nucleus", "Pegg'd", "Clinkle", "Tables", "HooliChat", "PiperChat", "Not Hotdog", "PeaceFare", "CodeRag" ]
+inventions: [ "Telehuman", "Liquid Shrimp", "Bit Soup", "Audacious", "Tres Comas Tequila", "Pipey", "Always Blue", "Cold Duck", "Skycrane", "Octopus Recipes", "Limp Biscuit", "Hooli Box", "Box Two", "Table", "Anton", "BamBot", "Human Heater" ]
+mottos: [
+  "Cloud-based, disruptive systems",
+  "Creating unique cross-platform technologies",
+  "Making the world a better place",
+  "Awesome world-changing compression company",
+  "So maybe the reason we share so much is because we understand that without sharing, we can't survive. And sharing is tables.",
+  "Forced adoption through aggressive guerrilla marketing",
+  "Powered by the spirit of exploration and the thrill of the pursuit of the unimaginable",
+  "We not only think outside of the box, we think outside of the box that box is in - and so on - until innovation is free of all boxes that would contain and constrain it",
+  "Our products are products, producing unrivaled results",
+  "Oh, danger will most certainly be proceeded in the face of. Right in its face. Right in it.",
+  "Isn't it time someone put the venture back into venture capital?",
+  "Are bandwidth costs harshing on your vibe?",
+  "The drink that doesn't give a fuck!"
+]
+urls: [
+  "http://raviga.com",
+  "http://breamhall.com",
+  "http://piedpiper.com",
+  "http://hooli.com",
+  "http://bachmanity.com",
+  "http://aviato.com",
+  "http://coderag.com",
+  "http://endframesystems.com",
+  "http://drinkhomicide.com"
+]
+email: ['richard@piedpiper.test', 'bertram@piedpiper.test', 'dinesh@piedpiper.test', 'jared@piedpiper.test', 'bighead@nipplealert.test', 'erlich@bachmanity.test', 'monica@raviga.test', 'laurie@raviga.test', 'gavin@hooli.test', 'russ@threecommaclub.test', 'denpok@hooli.test']

data/lib/voom/presenters/demo/search.rb

@@ -0,0 +1,29 @@
+require 'sinatra/base'
+
+module Voom
+  module Presenters
+    module Demo
+      class Search < Sinatra::Base
+        get('/_search_') do
+          content_type :json
+          JSON.dump(search(params[:search]))
+        end
+        
+        def search(term)
+          require 'yaml'
+          return [] unless term
+          @terms ||= YAML::load_file(File.join(__dir__, './search-terms.yml'))
+          @terms.keys.reduce([]) do |matches, topic|
+            @terms[topic].reduce(matches) do |matches, item|
+              matches << [item, matches.length] if item.downcase.include?(term.downcase)
+              matches
+            end
+          end
+        end
+
+        # start the server if ruby file executed directly
+        run! if app_file == $0
+      end
+    end
+  end
+end

data/lib/voom/presenters/dsl.rb

@@ -0,0 +1,60 @@
+require 'voom/trace'
+
+module Voom
+  module Presenters
+    def self.define(name, &block)
+      DSL.define(name, &block)
+    end
+
+    module DSL
+      class << self
+        include Voom::Trace
+      end
+
+      @registry = {}
+
+      def self.registry
+        @registry
+      end
+
+      def self.define(name, &block)
+        registry[name] = Voom::Presenters::DSL::Definition.new(&block)
+      end
+
+      def self.load(directory)
+        files = File.join(directory, '**', '*.pom')
+        Dir.glob(files) do |file|
+          Kernel.load file
+        end
+      end
+
+      def self.finalize
+        registry.each do |key, definition|
+          begin
+            register(key, build(definition))
+          rescue Exception => e
+            logger.error {"Failed to load presenter #{key}: #{e.inspect}."}
+            raise e
+          end
+        end
+      end
+
+      # This method empties out the dsl definitions
+      # It should ONLY be used for testing purposes
+      def self.reset!
+        registry.clear
+      end
+
+      private
+
+      def self.register(name, definition)
+        return Voom::Presenters::App.register(name: name, presenter: definition) unless Voom::Presenters::App.registered?(name)
+        logger.warn {"Warning attempted to redefine the presenter: #{name}!"}
+      end
+
+      def self.build(definition)
+        definition.build
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+require_relative 'base'
+
+module Voom
+  module Presenters
+    module DSL
+      module Components
+        class Action < Base
+          # Options are used by the actions
+          # Params are passed by the user
+          attr_reader :params, :options
+
+          def initialize(type:, **attribs_, &block)
+            super(type: type, **attribs_, &block)
+            @options = {}
+            extract_options!
+            @params = attribs.delete(:params) {{}}
+            @url = nil
+          end
+
+          def url
+            @parent.router.url(render: options[:presenter], command: options[:path], context: params)
+          end
+
+          private
+          def extract_options!
+            %i(path presenter target).each do |option|
+              optionValue = attribs.delete(option)
+              @options.merge!({option => optionValue}) if optionValue
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+require_relative 'event_base'
+require_relative 'mixins/event'
+require_relative 'mixins/tooltips'
+
+module Voom
+  module Presenters
+    module DSL
+      module Components
+        class Avatar < EventBase
+          include Mixins::Tooltips
+
+          attr_accessor :avatar, :color, :size, :position
+
+          def initialize(**attribs_, &block)
+            super(type: :avatar, context: context,
+                  **attribs_, &block)
+            @avatar = attribs.delete(:avatar)
+            @color = attribs.delete(:color)
+            @size = attribs.delete(:size)
+            @position    = Array(attribs.delete(:position)).compact
+            expand!
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require_relative 'mixins/event'
+
+module Voom
+  module Presenters
+    module DSL
+      module Components
+        class Badge < EventBase
+          attr_accessor :badge, :icon, :text
+
+          def initialize(**attribs_, &block)
+            super(type: :badge, **attribs_, &block)
+            @badge = attribs.delete(:badge)
+            @icon = attribs.delete(:icon)
+            @text = attribs.delete(:text)
+            expand!
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+require_relative '../lockable'
+require_relative '../../../serializer'
+require_relative '../../../trace'
+
+require 'securerandom'
+
+module Voom
+  module Presenters
+    module DSL
+      module Components
+        # Every object in the POM is a node
+        # This class provides common base implementation
+        class Base
+          include Lockable
+
+          include Voom::Serializer
+          include LoggerMethods
+          include Trace
+
+          attr_reader :type, :id, :attributes, :context
+
+          alias params context
+          alias attribs attributes
+
+          def initialize(type:, parent:, id: nil, context: {}, **attributes, &block)
+            @id = h(id) || generate_id
+            @type = h(type)
+            @parent = parent
+            @context = context
+            @attributes = escape(attributes)
+            @block = block
+          end
+
+          def expand!
+            extend(_helpers_) if _helpers_
+            instance_eval(&@block) if @block
+          end
+
+          private
+
+          def h(text)
+            return text unless text.is_a? String
+            CGI::escapeHTML(text)
+          end
+
+          def escape(attributes)
+            attributes.map {|k, v| [k, h(v)]}.to_h
+          end
+
+          def generate_id
+            Voom::Presenters::Settings.config.presenters.id_generator.call(self)
+          end
+      
+          protected
+
+          def parent(for_type)
+            return @parent if @parent.type == for_type
+            @parent.send(:parent, for_type)
+          end
+
+          def router
+            @parent.send(:router)
+          end
+
+          def yield_block
+            return @_yield_block_ if @_yield_block_
+            @parent.send(:yield_block)
+          end
+
+          def _helpers_
+            @parent.send(:_helpers_) if @parent
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+require_relative 'mixins/common'
+require_relative 'mixins/event'
+require_relative 'mixins/tooltips'
+
+module Voom
+  module Presenters
+    module DSL
+      module Components
+        class Button < EventBase
+          include Mixins::Tooltips
+          BUTTON_TYPES = %i(raised flat fab icon)
+
+          attr_accessor :text, :icon, :button_type, :color, :disabled, :size, :position
+
+          def initialize(type: nil, **attribs_, &block)
+            @button_type = h(type) || ((attribs_[:icon]&&!attribs_[:text]) ? :icon : nil) || :flat
+            super(type: :button, **attribs_, &block)
+            self.icon(attribs.delete(:icon)) if attribs.key?(:icon)
+            @text = attribs.delete(:text)
+            @color = attribs.delete(:color)
+            @disabled = attribs.delete(:disabled) || false
+            @size = attribs.delete(:size)
+            @position = Array(attribs.delete(:position)).compact
+            expand!
+            @event_parent_id = self.parent(:form)&.id || id
+          end
+
+          def icon(icon=nil, **attribs, &block)
+            return @icon if locked?
+            @icon = Components::Icon.new(parent: self, icon: icon,
+                                         context: context,
+                                         **attribs, &block)
+
+          end
+
+          def menu(**attributes, &block)
+            return @menu if locked?
+            @menu = Components::Menu.new(parent: self, position: menu_position, context: context, **attributes, &block)
+          end
+
+          private
+          def menu_position
+            position.include?(:right) ? :right : nil
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,119 @@
+require_relative 'menu'
+require_relative 'typography'
+require_relative 'mixins/common'
+require_relative 'mixins/event'
+require_relative 'mixins/attaches'
+require_relative 'mixins/avatar'
+require_relative 'mixins/text_fields'
+require_relative 'mixins/icons'
+require_relative 'mixins/snackbars'
+
+module Voom
+  module Presenters
+    module DSL
+      module Components
+        class Card < EventBase
+          include Mixins::Common
+          include Mixins::Attaches
+          include Mixins::TextFields
+          include Mixins::Icons
+          include Mixins::Snackbars
+
+          attr_reader :height, :width, :selected, :components, :shows_errors
+
+
+          def initialize(**attribs_, &block)
+            super(type: :card, **attribs_, &block)
+            @height = attribs.delete(:height)
+            @width = attribs.delete(:width)
+            @selected = attribs.delete(:selected) {false}
+            self.text(attribs.delete(:text)) if attribs.key?(:text)
+            @shows_errors = attribs.delete(:shows_errors){true}
+
+            @components = []
+            expand!
+          end
+
+          def media(**attribs, &block)
+            return @media if locked?
+            @media = Media.new(parent: self,
+                               context: context,
+                               **attribs, &block)
+          end
+
+          # def overflow_menu(**attribs, &block)
+          #   return @overflow_menu if locked?
+          #   icon = attribs.delete(:icon){:more_vert}
+          #   position = attribs.delete(:position){ [:top, :right]}
+          #   @overflow_menu = Components::Button.new(parent: self,
+          #                                                    icon: icon,
+          #                                                    position: position,
+          #                                                    context: context,
+          #                                                    **attribs, &block)
+          # end
+
+          class Media < Base
+            include Mixins::Avatar
+            attr_reader :height, :width, :color
+
+            def initialize(**attribs_, &block)
+              super(type: :media, **attribs_, &block)
+              @height = attribs.delete(:height)
+              @width = attribs.delete(:width)
+              @color = attribs.delete(:color)
+
+              expand!
+            end
+
+            def title(*title, **attribs, &block)
+              return @title if locked?
+              @title = Typography.new(type: :title,
+                                      parent: self,
+                                      text: title,
+                                      context: context,
+                                      **attribs, &block)
+            end
+
+            def image(image=nil, **attribs, &block)
+              return @image if locked?
+              @image = Image.new(parent: self, image: image, context: context, **attribs, &block)
+            end
+
+            def button(icon=nil, **attributes, &block)
+              return @button if locked?
+              @button = Components::Button.new(icon: icon, position:[:top, :right], parent: self, context: context, **attributes, &block)
+            end
+          end
+
+          def text(*text, **attribs, &block)
+            self << Typography.new(type: :body,
+                                   parent: self, text: text, context: context, **attribs, &block)
+          end
+
+          def actions(**attribs, &block)
+            return @actions if locked?
+            @actions = Actions.new(parent: self,
+                                   context: context,
+                                   **attribs, &block)
+          end
+
+          class Actions < Base
+            attr_accessor :buttons
+
+            def initialize(**attribs_, &block)
+              super(type: :action, **attribs_, &block)
+              @buttons = []
+              expand!
+            end
+
+            def button(text=nil, **options, &block)
+              @buttons << Components::Button.new(parent: self, text: text,
+                                                 context: context,
+                                                 **options, &block)
+            end
+          end
+        end
+      end
+    end
+  end
+end