status_tag 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e40ce1236e635e3ebe7e29aa9894a3058958041b
+  data.tar.gz: a50a76c6ddac86762f4609bb91812b5291672132
+SHA512:
+  metadata.gz: 595707bd6f6597902fae0f2f42ef16aec5af4b3c3a9afecc6d26c0c4d5de069615890e4af848e77fdf43d9059e7483f4fae8c9799134bc97838fc534ee6a0a93
+  data.tar.gz: a9da7ece09d57c4da07f8d7a6ce9dd6902460d48c9cbcfeeca5eed42ac4fd79e11a90a5cd0e6552b5082852589368e6c69c49d1bf5caeefc38222526b8fc2bee

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in status_tag.gemspec
+gemspec

data/README.md

@@ -0,0 +1,46 @@
+# StatusTag
+
+SRP:  Provides a method signature that can be splatted to Rails' `content_tag_for` to create labels.
+Flexible: not explicitly dependent on bootstrap or any other style framework.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'status_tag'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install status_tag
+
+## Usage
+
+Example:
+
+```ruby
+# Recommend putting the following in a helper method.
+# signature may be nil, which is an indication that the chosen label was marked as a noop.
+text, signature = StatusTag::Presenter.status_tag_signature_for(:span, user, "state")
+if signature
+  content_tag_for(*signature) do
+    text
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/status_tag.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "status_tag"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/status_tag.rb

@@ -0,0 +1,51 @@
+require "status_tag/version"
+require "status_tag/utils"
+require "status_tag/choice"
+require "status_tag/decider"
+require "status_tag/presenter"
+require "status_tag/null_presenter"
+
+module StatusTag
+
+  extend StatusTag::Utils
+
+  def self.status_tag_presenter(object:, aspect: nil)
+    # Support for STI and namespaced Objects is accomplished by
+    #   first checking for a Presenter definition at the STI class level
+    #   and then checking for a definition at the super class (generic) level.
+    namespaces = namespaces_from_class(object.class)
+    presenter = nil
+    namespaces.inject(object.class) do |namespace, memo|
+      if aspect.nil?
+        # recommend locating class definition at app/presenters/status_tag/<klass>_presenter.rb
+        presenter_class = class_from_string("StatusTag::#{memo}Presenter")
+        presenter = presenter_class.new(object: object) if presenter_class
+      else
+        presenter_class = class_from_string("StatusTag::#{memo}Presenters::#{camelize_underscored(aspect.to_s)}Presenter")
+        # recommend locating class definition at app/presenters/status_tag/<klass>_presenters/<aspect>_presenter.rb
+        presenter = presenter_class.new(object: object, aspect: aspect) if presenter_class
+      end
+      break if presenter
+      last_namespace = memo.rindex("::")
+      memo = memo[0..(last_namespace-1)] if last_namespace # level up!
+      memo
+    end
+    presenter = NullPresenter.new(object: object) unless presenter
+    presenter
+  end
+
+  # Same signature as Rails' `content_tag_for`.
+  # However, does not currently support object being multiple records like Rails' `content_tag_for` does
+  def self.status_tag_signature_for(tag, object, prefix = false, options = nil)
+    presenter = status_tag_presenter(object: object, aspect: prefix)
+    choice = presenter.decide
+    return choice.text, nil if choice.noop?
+    options ||= {}
+    options[:class] = Array(options[:class])
+    options[:class].concat(Array(presenter.class.css_class(object, prefix)))
+    options[:class] << choice.klass
+    options[:class] = options[:class].join(" ")
+    return choice.text, [tag, presenter.object, presenter.aspect, options]
+  end
+
+end

data/lib/status_tag/choice.rb

@@ -0,0 +1,26 @@
+module StatusTag
+  class Choice
+
+    attr_accessor :name,  # the method that will be called on the object to determine if this is the correct choice
+                          #   when nil, indicates this choice is the catch-all, naked `else`
+                  :klass, # klass is for the CSS class that will differentiate each specific label type (color, size, etc)
+                  :text,  # text is the what the label says in the view port
+                  :noop   # designates a `name` as taking up space, but not rendering a tag, in the ordered set to tumble the results.
+
+    def initialize(name: nil, klass: "", text: "", noop: false)
+      @name = name
+      @klass = klass
+      @text = text
+      @noop = !!noop
+    end
+
+    def catch_all?
+      name.nil?
+    end
+
+    def noop?
+      noop
+    end
+
+  end
+end

data/lib/status_tag/decider.rb

@@ -0,0 +1,21 @@
+module StatusTag
+  class Decider
+
+    attr_accessor :ordered_choices
+
+    def initialize(ordered_choices:)
+      @ordered_choices = ordered_choices
+    end
+
+    def decide(object)
+      ordered_choices.detect do |choice|
+        if choice.catch_all?
+          true
+        else
+          object.send(choice.name)
+        end
+      end
+    end
+
+  end
+end

data/lib/status_tag/null_presenter.rb

@@ -0,0 +1,6 @@
+# An example of what a Presenter would look like.
+module StatusTag
+  class NullPresenter < Presenter
+    ORDERED_CHOICES = [StatusTag::Choice.new(text: "null presenter")]
+  end
+end

data/lib/status_tag/presenter.rb

@@ -0,0 +1,52 @@
+# SRP:  Provides a method signature that can be splatted to content_tag_for to create labels
+#
+#       This base class can be used to instantiate a label for anything.
+#       Subclasses will address specific needs, like a label for user status, order status, job state, etc.
+#       Flexible: not explicitly dependent on bootstrap or any other style framework.
+#
+# Example:
+#
+#       text, signature = StatusTag::Presenter.status_tag_signature_for(:span, mtm_profile, "fit_status")
+#       content_tag_for(*signature) do
+#         text
+#       end
+
+module StatusTag
+  class Presenter
+
+    # Override constants in subclasses
+    ORDERED_CHOICES = [StatusTag::Choice.new]
+    CSS_CLASS = [] # A CSS class or classes to assign to all tags generated with the presenter
+
+    attr_accessor :object,  # e.g. an instance of the User class
+                  :aspect   # e.g. "state", "status" or some other descriptive name for this particular status tag
+                            #       Defaults to nil, so by default there is only one StatusTag presenter allowed per object class,
+                            #       as the aspect provides a namespace for additional presenters.
+    attr_reader :decider
+
+    def initialize(object:, aspect: nil)
+      @object = object
+      @aspect = aspect
+      @decider = StatusTag::Decider.new(ordered_choices: self.class.ordered_choices(object, aspect))
+    end
+
+    def decide
+      decider.decide(object)
+    end
+
+    # An alternative to overriding the constant in subclasses is to override this method.
+    # If you override, do not change the signature.
+    # The params enable the ordered choices to be derived dynamically for your needs, but are not used by default.
+    def self.ordered_choices(object, aspect)
+      self::ORDERED_CHOICES
+    end
+
+    # An alternative to overriding the CSS_CLASS constant in subclasses is to override this method.
+    # If you override, do not change the signature.
+    # The params enable the ordered choices to be derived dynamically for your needs, but are not used by default.
+    def self.css_class(object, aspect)
+      self::CSS_CLASS
+    end
+
+  end
+end

data/lib/status_tag/utils.rb

@@ -0,0 +1,23 @@
+module StatusTag
+  module Utils
+
+    MOD_SEPARATOR = "::"
+
+    def class_from_string(str)
+      str.split(MOD_SEPARATOR).inject(Object) do |mod, class_name|
+        mod.const_get(class_name)
+      end
+    rescue
+      nil
+    end
+
+    def namespaces_from_class(klass)
+      klass.to_s.split(MOD_SEPARATOR)
+    end
+
+    def camelize_underscored(str)
+      str.split('_').map {|w| w.capitalize}.join
+    end
+
+  end
+end

data/lib/status_tag/version.rb

@@ -0,0 +1,3 @@
+module StatusTag
+  VERSION = "0.1.0"
+end

data/mtm_profile/blazer_presenters/fit_status_presenter.rb

@@ -0,0 +1,17 @@
+module StatusTag
+  module MtmProfilePresenters
+    class FitStatusPresenter < Presenter
+      ORDERED_CHOICES = [
+          StatusTag::Choice.new(name: "new?", klass: "label-default-important", text: "B New"),
+          StatusTag::Choice.new(name: "bad_fit?", klass: "label-default-warning", text: "B Bad Fit"),
+          StatusTag::Choice.new(name: "confirmed?", klass: "label-default-success", text: "B Fit Confirmed"),
+          StatusTag::Choice.new(name: "pending?", noop: true), # TODO: Why do we not want pending to display?
+          StatusTag::Choice.new(name: nil, klass: "label-default-warning", text: "B Fit Unknown"),
+      ]
+      CSS_CLASS = [
+          "label",
+          "label-default"
+      ]
+    end
+  end
+end

data/mtm_profile/blazer_presenters/measurement_status_presenter.rb

@@ -0,0 +1,18 @@
+module StatusTag
+  module MtmProfilePresenters
+    class MeasurementStatusPresenter < Presenter
+      ORDERED_CHOICES = [
+          StatusTag::Choice.new(name: "bad?", klass: "label-default-warning", text: "B Bad Measure"),
+          StatusTag::Choice.new(name: "good?", klass: "label-default-success", text: "B Good Measure"),
+          StatusTag::Choice.new(name: "waiting_approval?", klass: "label-default-important", text: "B Pending Measure"),
+          StatusTag::Choice.new(name: "on_hold?", klass: "label-default-warning", text: "B On Hold"),
+          StatusTag::Choice.new(name: "not_measured?", klass: "label-default-important", text: "B Not Measured"),
+          StatusTag::Choice.new(name: nil, klass: "label-default-warning", text: "B Measure Unknown"),
+      ]
+      CSS_CLASS = [
+          "label",
+          "label-default"
+      ]
+    end
+  end
+end

data/mtm_profile_presenters/fit_status_presenter.rb

@@ -0,0 +1,17 @@
+module StatusTag
+  module MtmProfilePresenters
+    class FitStatusPresenter < Presenter
+      ORDERED_CHOICES = [
+          StatusTag::Choice.new(name: "new?", klass: "label-default-important", text: "New"),
+          StatusTag::Choice.new(name: "bad_fit?", klass: "label-default-warning", text: "Bad Fit"),
+          StatusTag::Choice.new(name: "confirmed?", klass: "label-default-success", text: "Fit Confirmed"),
+          StatusTag::Choice.new(name: "pending?", noop: true), # TODO: Why do we not want pending to display?
+          StatusTag::Choice.new(name: nil, klass: "label-default-warning", text: "Fit Unknown"),
+      ]
+      CSS_CLASS = [
+          "label",
+          "label-default"
+      ]
+    end
+  end
+end

data/mtm_profile_presenters/measurement_status_presenter.rb

@@ -0,0 +1,18 @@
+module StatusTag
+  module MtmProfilePresenters
+    class MeasurementStatusPresenter < Presenter
+      ORDERED_CHOICES = [
+          StatusTag::Choice.new(name: "bad?", klass: "label-default-warning", text: "Bad Measure"),
+          StatusTag::Choice.new(name: "good?", klass: "label-default-success", text: "Good Measure"),
+          StatusTag::Choice.new(name: "waiting_approval?", klass: "label-default-important", text: "Pending Measure"),
+          StatusTag::Choice.new(name: "on_hold?", klass: "label-default-warning", text: "On Hold"),
+          StatusTag::Choice.new(name: "not_measured?", klass: "label-default-important", text: "Not Measured"),
+          StatusTag::Choice.new(name: nil, klass: "label-default-warning", text: "Measure Unknown"),
+      ]
+      CSS_CLASS = [
+          "label",
+          "label-default"
+      ]
+    end
+  end
+end

data/status_tag.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'status_tag/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "status_tag"
+  spec.version       = StatusTag::VERSION
+  spec.authors       = ["Peter Boling"]
+  spec.email         = ["peter.boling@gmail.com"]
+
+  spec.summary       = %q{Provides content_tag_for method signature to create labels from Ruby objects}
+  spec.description   = %q{Provides content_tag_for method signature to create customizable and logic-gated labels from objects.
+Also includes a presenter base class to allow any Ruby web framework to create logic around HTML tags}
+  spec.homepage      = "http://github.com/pboling/status_tag"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: status_tag
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter Boling
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  Provides content_tag_for method signature to create customizable and logic-gated labels from objects.
+  Also includes a presenter base class to allow any Ruby web framework to create logic around HTML tags
+email:
+- peter.boling@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/status_tag.rb
+- lib/status_tag/choice.rb
+- lib/status_tag/decider.rb
+- lib/status_tag/null_presenter.rb
+- lib/status_tag/presenter.rb
+- lib/status_tag/utils.rb
+- lib/status_tag/version.rb
+- mtm_profile/blazer_presenters/fit_status_presenter.rb
+- mtm_profile/blazer_presenters/measurement_status_presenter.rb
+- mtm_profile_presenters/fit_status_presenter.rb
+- mtm_profile_presenters/measurement_status_presenter.rb
+- status_tag.gemspec
+homepage: http://github.com/pboling/status_tag
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Provides content_tag_for method signature to create labels from Ruby objects
+test_files: []