ad2games-ui_components 2.0.0

data/app/cells/select/select.yml

@@ -0,0 +1,14 @@
+description: 'A searchable selectbox.'
+examples:
+  - slim: |
+      - bootstrap_form_for(:foo, url: '/') do |f|
+        = ui_component 'select', form: f,
+                                 name: 'foo',
+                                 select_options: [['Foo', 1], ['Bar', 2], ['Baz', 3]]
+  - description: 'Setting the `required` option to `true` will disallow deselecting selected options.'
+    slim: |
+      - bootstrap_form_for(:foo, url: '/') do |f|
+        = ui_component 'select', form: f,
+                                 name: 'foo',
+                                 select_options: [['Foo', 1], ['Bar', 2], ['Baz', 3]],
+                                 required: true

data/app/cells/select/select_cell.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+class SelectCell < FormCellBase
+  attribute :disabled, description: 'Whether or not the field is disabled.'
+  attribute :form, mandatory: true, description: 'A form object.'
+  attribute :name, mandatory: true, description: 'The name attribute.'
+  attribute :select_options, description: 'Select options of the form `[[label, value]]`.'
+  attribute :label, description: 'A label. If not provided it will be derived from `name`.'
+  attribute :skip_label, description: 'Whether to not show the label.'
+  attribute :required, description: 'Whether or not the field is required.'
+  attribute :multiple, description: 'Enable multi-select behavior.'
+  attribute :placeholder, description: 'A placeholder text.'
+  attribute :error, description: 'An error message to display (E.g. on failed validations).'
+  attribute :width, description: 'The width of the component.'
+  attribute :remote_options, description: 'A URL path to load the options from.'
+  attribute :inline, description: 'Whether or not the element should be rendered inline.'
+  attribute :classes, description: 'CSS classes to be added to the element.'
+  attribute :label_col, description: 'CSS col class applied to the label, defaults to `col-sm-2`'
+  attribute :control_col,
+    description: 'CSS col class applied to the control, defaults to `col-sm-10`'
+  attribute :hide_label,
+    description: 'Hide the label, but keep it accessible to screen readers (e.g. Capybara)'
+  attribute :help, description: 'Help text associated with the control'
+
+  def show
+    options[:form].select(
+      options[:name],
+      select_options,
+      control_options,
+      html_options
+    )
+  end
+
+  private
+
+  def control_options
+    options
+      .slice(:label, :skip_label, :hide_label, :label_col, :control_col, :help)
+      .merge(include_blank: true)
+  end
+
+  def html_options
+    html_opts = { class: css_class }
+    html_opts.update(options.slice(:required, :multiple, :disabled))
+    html_opts[:data] = options.slice(:placeholder, :error, :width, :remote_options)
+    html_opts[:data][:allow_single_deselect] = !options[:required]
+    html_opts
+  end
+
+  def select_options
+    options[:select_options] || []
+  end
+
+  def css_class
+    classes = %w(form-control ui-components-select chosen)
+    classes << 'chosen-inline' if options[:inline]
+    classes << options[:classes] if options[:classes]
+    classes.join(' ')
+  end
+end

data/app/helpers/ui_components/view_helper.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+module UiComponents
+  module ViewHelper
+    def ui_component(name, options = {})
+      cell(name.to_sym, nil, options).call(:show)
+    end
+  end
+end

data/lib/generators/generate_component.thor

@@ -0,0 +1,32 @@
+require 'thor/group'
+require 'active_support/core_ext/string'
+
+class GenerateComponent < Thor::Group
+  include Thor::Actions
+
+  argument :name, type: :string, desc: "The component's name."
+  desc 'Create a new component.'
+  source_root File.expand_path('../../ui_components/templates', __FILE__)
+
+  def create_cell
+    template 'cell.tt',
+             "app/cells/#{name}/#{name}_cell.rb"
+  end
+
+  def create_view
+    template 'view.tt',
+             "app/cells/#{name}/#{name}.slim"
+  end
+
+  def create_config
+    template 'config.tt',
+             "app/cells/#{name}/#{name}.yml"
+  end
+
+  def create_assets
+    template 'coffee.tt',
+             "app/cells/#{name}/#{name}.coffee"
+    template 'sass.tt',
+             "app/cells/#{name}/#{name}.scss"
+  end
+end

data/lib/tasks/styleguide.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+desc 'Run the styleguide on :port (defaults to 3999).'
+task :styleguide, %i(port) do |_, args|
+  FileUtils.cd(UiComponents::Engine.root.join('spec', 'dummy')) do
+    port = args[:port] || 3999
+    exec "bundle exec rails s -p #{port}"
+  end
+end

data/lib/ui_components.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+Gem.loaded_specs['ad2games-ui_components'].dependencies.each do |gem|
+  require gem.name if gem.type == :runtime
+end
+require 'active_model/railtie'
+require 'ui_components/engine'
+require 'ui_components/cell_attributes'
+require 'ui_components/docu_cop'
+require 'ui_components/cell'
+require 'ui_components/form_helper'
+require UiComponents::Engine.root.join('app', 'cells', 'form_cell_base')
+Dir.glob(UiComponents::Engine.root.join('app', 'cells', '*', '*.rb')).each { |c| require c }
+
+ActionView::Base.include UiComponents::FormHelper

data/lib/ui_components/cell.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require_relative '../../app/helpers/ui_components/view_helper'
+
+module UiComponents
+  class Cell < ::Cell::ViewModel
+    include UiComponents::ViewHelper
+    include CellAttributes
+    include DocuCop
+
+    view_paths << Engine.root.join('app', 'cells')
+
+    def show
+      render(self.class.name.to_sym)
+    end
+  end
+end

data/lib/ui_components/cell_attributes.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+module UiComponents
+  module CellAttributes
+    extend ActiveSupport::Concern
+
+    def initialize(*args)
+      super
+      options.except(:controller).each do |k, v|
+        public_send(:"#{k}=", v)
+      end
+      validate_mandatory_attributes
+    end
+
+    def attributes
+      self.class.attributes.keys.map do |k|
+        [k, public_send(k)]
+      end.to_h
+    end
+
+    private
+
+    def validate_mandatory_attributes
+      missing_attributes = self.class.attributes
+        .select { |a| a[:mandatory] && public_send(a[:name]).nil? }
+      return if missing_attributes.empty?
+      raise MandatoryAttributeNotSet,
+        'Following mandatory attribute(s) have not been provided: ' +
+        missing_attributes.map { |m| m[:name] }.join(', ')
+    end
+
+    class MandatoryAttributeNotSet < StandardError; end
+
+    class_methods do
+      def attribute(name, options = {})
+        options = ActionController::Parameters.new(options)
+        attributes << {
+          name: name,
+          mandatory: options[:mandatory] == true,
+          description: options.require(:description)
+        }
+        attr_accessor name
+      end
+
+      def attributes
+        @attributes ||= []
+      end
+    end
+  end
+end

data/lib/ui_components/docu_cop.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+module UiComponents
+  module DocuCop
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def name
+        to_s.underscore.sub(/_cell\Z/, '')
+      end
+
+      def title
+        name.titleize
+      end
+
+      def examples
+        documentation[:examples].presence ||
+          raise("No examples provided for #{name} component")
+      end
+
+      def description
+        documentation[:description].presence ||
+          raise("No description provided for '#{name}' component")
+      end
+
+      def documentation
+        file = Engine.root.join('app', 'cells', name, "#{name}.yml")
+        YAML.load(File.read(file)).deep_symbolize_keys
+      end
+    end
+  end
+end

data/lib/ui_components/engine.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module UiComponents
+  class Engine < ::Rails::Engine
+    initializer 'ui_components.assets.add_load_paths' do |app|
+      app.config.assets.paths += self.class.components_paths
+      app.config.assets.paths << root.join('vendor/assets/bower_components')
+    end
+
+    initializer 'ui_components.assets.precompile' do |app|
+      app.config.assets.precompile += %w(styleguide.js
+                                         styleguide.css)
+      app.config.assets.precompile +=
+        self.class.components_paths
+          .map(&:basename)
+          .map { |p| ["#{p}.js", "#{p}.css"] }
+          .flatten
+
+      app.config.assets.precompile += %w(chosen/chosen-sprite.png
+                                         chosen/chosen-sprite@2x.png)
+    end
+
+    def self.components_paths
+      Dir[root.join('app/cells/*/')].map { |path| Pathname.new(path) }
+    end
+  end
+end

data/lib/ui_components/form_helper.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+module UiComponents
+  class ValidatedOpenStruct < OpenStruct
+    def self.validators_on(*)
+      []
+    end
+  end
+
+  module FormHelper
+    # TODO: Move to own component.
+    def modelless_form(options, &block)
+      model_params = options[:params] || params[options[:name]]
+      struct = ValidatedOpenStruct.new(model_params)
+      bootstrap_form_for(
+        struct,
+        as: options[:name],
+        url: options[:url].to_s,
+        method: options.fetch(:method, :post),
+        &block
+      )
+    end
+
+    # TODO: Move to DatagridFilterCell or own component.
+    def datagrid_filters(form, filters, options = {})
+      filter_markup = filters.map do |filter|
+        ui_component(:datagrid_filter, options.merge(form: form, filter: filter))
+      end
+
+      safe_join filter_markup
+    end
+  end
+end

data/lib/ui_components/templates/cell.tt

@@ -0,0 +1,2 @@
+class <%= name.camelize %>Cell < UiComponents::Cell
+end

data/lib/ui_components/templates/config.tt

@@ -0,0 +1,9 @@
+description: "I didn't change the default description."
+examples:
+  - attributes: {}
+
+  # Examples can consist of an attributes hash or a string of Slim markup:
+  #- attributes:
+  #    something: 'something'
+  #- slim: |
+  #    = ui_component('my_component', something: Something.new)

data/vendor/assets/bower_components/ajax-chosen/CHANGELOG.md

@@ -0,0 +1,10 @@
+## 1.0.1
+
+* Fix path to Bower main file
+
+## 1.0.0
+
+* Support for Chosen 1.x
+* Fix order of returned items / updated documentation
+* Compatibility with jQuery 1.9+
+* Add Bower support

data/vendor/assets/bower_components/ajax-chosen/Cakefile

@@ -0,0 +1,93 @@
+fs      = require 'fs'
+{exec}  = require 'child_process'
+util    = require 'util'
+{jsmin} = require 'jsmin'
+
+targetName    = "ajax-chosen"
+
+###
+CoffeeScript Options
+###
+csSrcDir      = "src"
+csTargetDir   = "lib"
+
+targetCoffee  = "#{csSrcDir}/build.coffee"
+targetJS      = "#{csTargetDir}/#{targetName}.js"
+targetMinJS   = "#{csTargetDir}/#{targetName}.min.js"
+
+coffeeOpts    = "-b -j #{targetName}.js -o #{csTargetDir} -c #{targetCoffee}"
+
+coffeeFiles   = [
+  "ajax-chosen"
+]
+
+###
+Event System
+###
+finishedCallback = {}
+finished = (type) ->      
+  finishedCallback[type]() if finishedCallback[type]?
+
+finishListener = (type, cb) ->
+  finishedCallback[type] = cb
+  
+notify = (msg) ->
+  return if not growl?
+  growl.notify msg, {title: "Heello Development", image: "Terminal"}
+  
+###
+Tasks
+###
+task 'docs', 'Generates documentation for the coffee files', ->
+  util.log 'Invoking docco on the CoffeeScript source files'
+  
+  files = coffeeFiles
+  files[i] = "#{csSrcDir}/#{files[i]}.coffee" for i in [0...files.length]
+
+  exec "docco #{files.join(' ')}", (err, stdout, stderr) ->
+    util.log err if err
+    util.log "Documentation built into docs/ folder."
+        
+task 'watch', 'Automatically recompile the CoffeeScript files when updated', ->
+  util.log "Watching for changes in #{csSrcDir}"
+  
+  for jsFile in coffeeFiles then do (jsFile) ->
+    fs.watchFile "#{csSrcDir}/#{jsFile}.coffee", (curr, prev) ->
+      if +curr.mtime isnt +prev.mtime
+        util.log "#{csSrcDir}/#{jsFile}.coffee updated"
+        invoke 'build'
+        
+task 'build', 'Compile and minify all CoffeeScript source files', ->
+  finishListener 'js', -> invoke 'minify'
+  invoke 'compile'
+
+task 'compile', 'Compile all CoffeeScript source files', ->
+  util.log "Building #{targetJS}"
+  contents = []
+  remaining = coffeeFiles.length
+  
+  util.log "Appending #{coffeeFiles.length} files to #{targetCoffee}"
+  
+  for file, index in coffeeFiles then do (file, index) ->
+    fs.readFile "#{csSrcDir}/#{file}.coffee", "utf8", (err, fileContents) ->
+      util.log err if err
+      
+      contents[index] = fileContents
+      util.log "[#{index + 1}] #{file}.coffee"
+      process() if --remaining is 0
+      
+  process = ->
+    fs.writeFile targetCoffee, contents.join("\n\n"), "utf8", (err) ->
+      util.log err if err
+      
+      exec "coffee #{coffeeOpts}", (err, stdout, stderr) ->
+        util.log err if err
+        util.log "Compiled #{targetJS}"
+        fs.unlink targetCoffee, (err) -> util.log err if err
+        finished('js')
+        
+task 'minify', 'Minify the CoffeeScript files', ->
+  util.log "Minifying #{targetJS}"
+  fs.readFile targetJS, "utf8", (err, contents) ->
+    fs.writeFile targetMinJS, jsmin(contents), "utf8", (err) ->
+      util.log err if err

data/vendor/assets/bower_components/ajax-chosen/Makefile

@@ -0,0 +1,2 @@
+all:
+	coffee -o lib/ -c src/

data/vendor/assets/bower_components/ajax-chosen/README.md

@@ -0,0 +1,131 @@
+# Ajax-Chosen
+
+This project is an addition to the excellent [Chosen jQuery plugin](https://github.com/harvesthq/chosen) that makes HTML input forms more friendly.  Chosen adds search boxes to `select` HTML elements, so I felt it could use the addition of ajax autocomplete for awesomely dynamic forms.
+
+This script bootstraps the existing Chosen plugin without making any modifications to the original code. Eventually, I would love to see this functionality built-in to the library, but until then, this seems to work pretty well.
+
+## Note about this fork
+
+This fork introduces compatibility for Chosen 1.x and a new plugin structure closer to the default jQuery plugin structure.
+
+Merge requests are still open on the main Ajax Chosen repository but haven't been merged.
+
+## How to Use
+
+This plugin exposes a new jQuery function named `ajaxChosen` that we call on a `select` element. The first argument consists of the options passed to the jQuery $.ajax function. The `data` parameter is optional, and the `success` callback is also optional.
+
+The second argument is a callback that tells the plugin what HTML `option` elements to make. It is passed the data returned from the ajax call, and you have to return an array of objects for which each item has a `value` property corresponding to the HTML `option` elements' `value` attribute, and a `text` property corresponding to the text to display for each option. In other words:
+
+	[{"value": 3, "text": "Ohio"}]
+
+becomes:
+
+	<option value="3">Ohio</option>
+
+or for grouping:
+
+	[{
+		group: true,
+		text: "Europe",
+		items: [
+			{ "value": "10", "text": "Stockholm" },
+			{ "value": "23", "text": "London" }
+		]
+	},
+	{
+		group: true,
+		text: "Asia",
+		items: [
+			{ "value": "36", "text": "Beijing" },
+			{ "value": "20", "text": "Tokyo" }
+		]
+	}]
+
+becomes:
+
+        <optgroup label="Europe">
+            <option value="10">Stockholm</option>
+            <option value="23">London</option>
+        </optgroup>
+        <optgroup label="Asia">
+            <option value="36">Beijing</option>
+            <option value="20">Tokyo</option>
+        </optgroup>
+
+Note: 
+
+Due to a bug in Chosen, it is necessary to change `choosen.css`.
+
+Add 
+
+	display: list-item;
+
+to 
+
+	.chzn-container .chzn-results .group-result {
+
+class
+
+### Options
+
+There are some additional ajax-chosen specific options you can pass into the first argument to control its behavior.
+
+* `minTermLength`: minimum number of characters that must be typed before an ajax call is fired
+* `afterTypeDelay`: how many milliseconds to wait after typing stops to fire the ajax call
+* `jsonTermKey`: the ajax request key to use for the search query (defaults to `term`)
+
+## Example Code
+
+``` js
+$("#example-input").ajaxChosen({
+	type: 'GET',
+	url: '/ajax-chosen/data.php',
+	dataType: 'json'
+}, function (data) {
+	var results = [];
+	
+	$.each(data, function (i, val) {
+		results.push({ value: val.value, text: val.text });
+	});
+	
+	return results;
+});
+```
+To have the results grouped in `optgroup` elements, have the function return a list of group objects instead:
+
+``` js
+$("#example-input").ajaxChosen({
+	type: 'GET',
+	url: '/ajax-chosen/grouped.php',
+	dataType: 'json'
+}, function (data) {
+	var results = [];
+
+	$.each(data, function (i, val) {
+		var group = { // here's a group object:
+			group: true,
+			text: val.name, // label for the group
+			items: [] // individual options within the group
+		};
+
+		$.each(val.items, function (i1, val1) {
+			group.items.push({value: val1.value, text: val1.text});
+		});
+
+		results.push(group);
+	});
+
+	return results;
+});
+
+```
+
+## Developing ajax-chosen
+
+In order to install development dependencies, you can run in the ajax-chosen directory:
+
+```
+npm install -d
+```
+
+ajax-chosen is written in Coffeescript, so there is a Cakefile provided that will perform all necessary tasks for you. Simply run `cake` to see all available commands.