houston-core 0.8.4 → 0.9.0.rc1

data/lib/houston/boot/extensions/deprecated.rb

@@ -0,0 +1,194 @@
+module Houston
+  module Extensions
+    module Deprecated
+
+
+      def add_project_column(_slug, &block)
+        Houston.deprecation_notice 'Houston.add_project_column is deprecated and will be removed in houston-core 1.0; use Houston.views["project"].add_column instead'
+
+        dsl = DeprecatedColumnDsl.new
+        dsl.instance_eval(&block)
+        dsl.add_to Houston.view["projects"]
+      end
+
+      def add_user_option(_slug, &block)
+        Houston.deprecation_notice 'Houston.add_user_option is deprecated and will be removed in houston-core 1.0; use Houston.views["edit_user"].add_field instead'
+
+        dsl = DeprecatedFieldDsl.new
+        dsl.instance_eval(&block)
+        dsl.add_to Houston.view["edit_user"]
+      end
+
+      def add_project_option(_slug, &block)
+        Houston.deprecation_notice 'Houston.add_project_option is deprecated and will be removed in houston-core 1.0; use Houston.views["edit_project"].add_field instead'
+
+        dsl = DeprecatedFieldDsl.new
+        dsl.instance_eval(&block)
+        dsl.add_to Houston.view["edit_project"]
+      end
+
+      def add_navigation_renderer(slug, &block)
+        Houston.deprecation_notice 'Houston.add_navigation_renderer is deprecated and will be removed in houston-core 1.0; use Houston.navigation.add_link instead'
+
+        dsl = DeprecatedNavigationDsl.new
+        dsl.instance_eval(&block)
+        dsl.add_to_navigation(slug)
+      end
+
+      def add_project_feature(slug, &block)
+        Houston.deprecation_notice 'Houston.add_project_feature is deprecated and will be removed in houston-core 1.0; use Houston.project_features.add instead'
+
+        dsl = DeprecatedProjectFeatureDsl.new
+        dsl.instance_eval(&block)
+        dsl.add_to_project_features(slug)
+      end
+
+      def add_project_header_command(slug, &block)
+        Houston.deprecation_notice 'Houston.add_project_header_command is deprecated and will be removed in houston-core 1.0'
+
+        dsl = ProjectBannerFeatureDsl.new(ProjectBannerFeature.new)
+        dsl.instance_eval(&block)
+        feature = dsl.feature
+        feature.slug = slug
+
+        project_header_commands.push feature
+      end
+
+      def project_header_commands
+        @project_header_commands ||= []
+      end
+
+
+
+
+
+
+      class DeprecatedColumnDsl
+        def name(value)
+          @name = value
+        end
+
+        def html(&block)
+          @render_block = block
+        end
+
+        def ability(&block)
+          @ability_block = block
+        end
+
+        def add_to(view)
+          column = view.add_column @name, &@render_block
+          ability_block = @ability_block
+          column.ability { ability_block.call(self) } if ability_block
+          column
+        end
+      end
+
+      class DeprecatedFieldDsl
+        attr_reader :label, :render_block
+
+        def name(value)
+          @label = value
+        end
+
+        def html(&block)
+          @render_block = block
+        end
+
+        def add_to(view)
+          render_block = @render_block
+          view.add_field(@label) { |*args| instance_exec(*args, &render_block).html_safe }
+        end
+      end
+
+      class DeprecatedNavigationDsl
+        def name(value)
+          @name = value
+        end
+
+        def path(&block)
+          @path_block = block
+        end
+
+        def ability(&block)
+          @ability_block = block
+        end
+
+        def add_to_navigation(slug)
+          Houston.navigation.add_link(slug, &@path_block).tap do |link|
+            ability_block = @ability_block
+            link.ability { ability_block.call(self) } if ability_block
+            link.name { @name } unless @name == slug.to_s.titleize
+          end
+        end
+      end
+
+      class DeprecatedProjectFeatureDsl
+        def initialize
+          @field_blocks = []
+        end
+
+        def name(value)
+          @name = value
+        end
+
+        def path(&block)
+          @path_block = block
+        end
+
+        def ability(&block)
+          @ability_block = block
+        end
+
+        def field(_slug, &block)
+          @field_blocks.push block
+        end
+
+        def add_to_project_features(slug)
+          raise ArgumentError, "Project Feature must supply name, but #{slug.inspect} doesn't" unless @name
+          raise ArgumentError, "Project Feature must supply path lambda, but #{slug.inspect} doesn't" unless @path_block
+
+          Houston.project_features.add(slug, &@path_block).tap do |feature|
+            ability_block = @ability_block
+            feature.ability { |project| ability_block.call(self, project) } if ability_block
+            feature.name { @name } unless @name == slug.to_s.titleize
+
+            @field_blocks.each do |block|
+              dsl = DeprecatedFieldDsl.new
+              dsl.instance_eval(&block)
+              dsl.add_to feature
+            end
+          end
+        end
+      end
+
+      class ProjectBannerFeature
+        attr_accessor :partial
+        attr_accessor :ability_block
+        attr_accessor :slug
+
+        def permitted?(ability, project)
+          return true if ability_block.nil?
+          ability_block.call ability, project
+        end
+      end
+
+      class ProjectBannerFeatureDsl
+        attr_reader :feature
+
+        def initialize(feature)
+          @feature = feature
+        end
+
+        def partial(value)
+          feature.partial = value
+        end
+
+        def ability(&block)
+          feature.ability_block = block
+        end
+      end
+
+    end
+  end
+end

data/lib/houston/boot/extensions/dsl.rb

@@ -0,0 +1,99 @@
+require "delegate"
+
+module Houston
+  module Extensions
+    module Permitted
+      def permitted?(ability, *args)
+        return true if @ability_block.nil?
+        ability.instance_exec(*args, &@ability_block)
+      end
+    end
+
+    module Render
+      def render(view, *args)
+        view.instance_exec(*args, &@render_block)
+      end
+    end
+
+    module LinkTo
+      def path(*args)
+        @path_block.call(*args)
+      end
+    end
+
+    module AbilityBlock
+      def ability(&block)
+        __getobj__.instance_variable_set :@ability_block, block
+      end
+    end
+
+    module AcceptsName
+      def name(*args)
+        __getobj__.name = args.first if args.any?
+        __getobj__.name
+      end
+    end
+
+    module HasTable
+      attr_reader :columns
+
+      def self.extended(view)
+        view.instance_variable_set :@columns, []
+      end
+
+      def add_column(name, &block)
+        Chain(AbilityBlock, Column.new(name).tap do |column|
+          column.instance_variable_set :@render_block, block
+          @columns << column
+        end)
+      end
+
+      def reset!
+        @columns = []
+        super
+      end
+
+      Column = Struct.new(:name) do
+        include Permitted, Render
+      end
+    end
+
+    module HasForm
+      attr_reader :fields
+
+      def self.extended(view)
+        view.instance_variable_set :@fields, []
+      end
+
+      def add_field(label, &block)
+        Chain(AbilityBlock, Field.new(label).tap do |field|
+          field.instance_variable_set :@render_block, block
+          @fields << field
+        end)
+      end
+
+      def reset!
+        @fields = []
+        super
+      end
+
+      Field = Struct.new(:label) do
+        include Permitted, Render
+
+        def id
+          "__props_#{label.tr(" ", "_").underscore}"
+        end
+      end
+    end
+
+  end
+end
+
+def Chain(*modules)
+  object = modules.pop
+  Class.new(SimpleDelegator).new(object).tap do |builder|
+    modules.each do |mod|
+      builder.extend mod
+    end
+  end
+end

data/lib/houston/boot/extensions/events.rb

@@ -0,0 +1,81 @@
+require "concurrent/array"
+
+module Houston
+  module Extensions
+    class Events
+      include Enumerable
+
+      def initialize
+        @events = Concurrent::Array.new
+      end
+
+      def each(&block)
+        @events.each(&block)
+      end
+
+      def [](event_name)
+        @events.find { |event| event.matches? event_name }
+      end
+
+      def registered?(event_name)
+        @events.any? { |event| event.matches? event_name }
+      end
+
+      def register(&block)
+        dsl = RegisterEventsDsl.new
+        hash = dsl.instance_eval(&block)
+        hash.each do |name, description|
+          @events.push Event.new(name, description.to_h)
+        end
+      end
+    end
+
+
+    class RegisterEventsDsl
+      def params(*params)
+        RegisterEventDsl.new.params(*params)
+      end
+
+      def description(value)
+        RegisterEventDsl.new.description(value)
+      end
+      alias :desc :description
+    end
+
+
+    class RegisterEventDsl
+      def initialize
+        @hash = {}
+      end
+
+      def params(*params)
+        @hash[:params] = params
+        self
+      end
+
+      def description(value)
+        @hash[:description] = value
+        self
+      end
+      alias :desc :description
+
+      def to_h
+        @hash
+      end
+    end
+
+
+    Event = Struct.new(:name, :description, :params) do
+      def initialize(name, options)
+        super name,
+          options.fetch(:description),
+          options.fetch(:params, [])
+        @matcher = Regexp.new("\\A#{name.gsub /\{([^:}]+)\}/, "(?<\\1>[^:]+)"}\\z")
+      end
+
+      def matches?(event_name)
+        @matcher === event_name # TODO: replace `===` with `.match?` on Ruby 2.4
+      end
+    end
+  end
+end

data/lib/houston/boot/extensions/features.rb

@@ -0,0 +1,42 @@
+require "concurrent/array"
+require "delegate"
+require "houston/boot/extensions/dsl"
+
+module Houston
+  module Extensions
+    class Features
+
+      def initialize
+        @features = Concurrent::Hash.new
+      end
+
+      def add(content, &path_block)
+        if content.is_a?(Symbol)
+          slug = content
+          content = slug.to_s.titleize
+        else
+          slug = content.underscore.to_sym
+        end
+        Chain(AbilityBlock, AcceptsName, Feature.new(slug, content).tap do |feature|
+          feature.instance_variable_set :@path_block, path_block
+          feature.extend Houston::Extensions::HasForm
+          @features[slug] = feature
+        end)
+      end
+      alias :<< :add
+
+      def all
+        @features.keys
+      end
+      alias :to_a :all
+
+      def [](slug)
+        @features.fetch(slug)
+      end
+    end
+
+    Feature = Struct.new(:slug, :name) do
+      include Permitted, LinkTo
+    end
+  end
+end

data/lib/houston/boot/extensions/layout.rb

@@ -0,0 +1,70 @@
+module Houston
+  module Extensions
+    class Layout
+      attr_reader :extensions_by_layout
+
+      def initialize
+        reset!
+      end
+
+      def reset!
+        @extensions_by_layout =
+          { "application" => Extensions.new,
+            "dashboard" => Extensions.new }
+      end
+
+      def [](layout)
+        raise ArgumentError, "#{layout} is not a layout. Valid layouts are #{extensions_by_layout.keys.join(", ")}" unless extensions_by_layout.key?(layout)
+        ExtensionDsl.new(extensions_by_layout, layout)
+      end
+
+      def all
+        ExtensionDsl.new(extensions_by_layout, *extensions_by_layout.keys)
+      end
+
+      delegate :meta, :stylesheets, :footers, :scripts, to: :all
+
+
+      class ExtensionDsl
+
+        def initialize(registry, *layouts)
+          @registry = registry
+          @layouts = layouts
+        end
+
+        def meta(&block)
+          add :meta, block
+        end
+
+        def stylesheets(&block)
+          add :stylesheets, block
+        end
+
+        def footers(&block)
+          add :footers, block
+        end
+
+        def scripts(&block)
+          add :scripts, block
+        end
+
+      private
+        attr_reader :registry, :layouts
+
+        def add(method, block)
+          layouts.each do |layout|
+            registry[layout].public_send(method) << block
+          end
+        end
+
+      end
+
+      Extensions = Struct.new(:meta, :stylesheets, :footers, :scripts) do
+        def initialize
+          super [], [], [], []
+        end
+      end
+
+    end
+  end
+end