looker 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88e622d4b8a2fbd5684a873a9b3e2c30beefd9fd
-  data.tar.gz: ab73433d9e9513e20b5853940b016e8afa0c4c16
+  metadata.gz: b33ca4cb16746cbe51209792863e034860525fe7
+  data.tar.gz: b91099734a0144e57d78e6f6bce5ad00d7bdaf1c
 SHA512:
-  metadata.gz: 809eb722dfeb22a1ab4785af98d9a77cef28177aadb082b4c1fadfdbc35999e5b436a19262e4480541468d587cc45948dbd074e739ef5610a0b3d9284f961985
-  data.tar.gz: 9069a79cdc8b699d0b5691105686c1ad82e7a2c513ba49cbbaf1368191e0699d917f5a2c30891cde517c8abfd4ae244d8d1891f919f6052b50f135947faff99f
+  metadata.gz: e10c6ec67d4bfbb3d6364303ac365bd76d23bf3a9838d18e7cbd244d106bc6cbb90703cbbd61b64e229d4caa8ed83a775663049272ab11a83d9fdc46d048382c
+  data.tar.gz: 59e9dcc96fd43d0a3d8faf69ca7c823729278a91998f58147ea7a93abdb73b82c595d3d324637c50362e5012bedb72a4b1a32e24ce276b4f6f0bb34b9d352c7c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    looker (0.1.0)
+    looker (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,3 +1,110 @@
+[![Lines of Code](http://img.shields.io/badge/lines_of_code-52-brightgreen.svg?style=flat)](http://blog.codinghorror.com/the-best-code-is-no-code-at-all/)
+[![Code Status](http://img.shields.io/codeclimate/github/hopsoft/looker.svg?style=flat)](https://codeclimate.com/github/hopsoft/looker)
+[![Dependency Status](http://img.shields.io/gemnasium/hopsoft/looker.svg?style=flat)](https://gemnasium.com/hopsoft/looker)
+[![Build Status](http://img.shields.io/travis/hopsoft/looker.svg?style=flat)](https://travis-ci.org/hopsoft/looker)
+[![Coverage Status](https://img.shields.io/coveralls/hopsoft/looker.svg?style=flat)](https://coveralls.io/r/hopsoft/looker?branch=master)
+[![Downloads](http://img.shields.io/gem/dt/looker.svg?style=flat)](http://rubygems.org/gems/looker)
+
 # Looker
 
 ## Hash based enumerated types (ENUMS)
+
+## Quick Start
+
+```sh
+gem install looker
+```
+
+```ruby
+Looker.add roles: {
+    :admin  => 1,
+    :reader => 2,
+    :writer => 3
+  }
+
+# The name (first Hash key) & value is converted
+# to an upcase named frozen constant on the Looker module
+
+Looker::ROLES[:admin]  # => 1
+Looker::ROLES[1]       # => :admin
+
+Looker::ROLES[:reader] # => 2
+Looker::ROLES[2]       # => :reader
+
+Looker::ROLES["writer"] # => 3
+Looker::ROLES[3]       # => :writer
+```
+
+__NOTE:__ You can perform lookups using both the key & value.
+
+## Multiple Enumerated Types
+
+It's possible to add multiple enumerated types with a single call to `Looker#add`.
+
+```ruby
+Looker.add(
+  roles: {
+    :admin  => 1,
+    :reader => 2,
+    :writer => 3
+  },
+
+  colors: {
+    :red    => "ff0000",
+    :yellow => "ffff00",
+    :blue   => "0000ff"
+  }
+)
+
+Looker::ROLES[:admin]    # => 1
+Looker::ROLES[3]         # => :writer
+
+Looker::COLORS[:red]     # => "ff0000"
+Looker::COLORS["ffff00"] # => :yellow
+```
+
+## Adding Enumerated Types from YAML
+
+It can be useful to manage enumerated type definitions with a YAML file.
+
+```yaml
+# /path/to/enums.yml
+roles:
+  admin: 1
+  reader: 2
+  writer: 3
+
+colors:
+  red: ff0000
+  yellow: ffff00
+  blue: 0000ff
+```
+
+```ruby
+Looker.add YAML.load(File.read("/path/to/enums.yml")
+
+Looker::ROLES["reader"]  # => 2
+Looker::ROLES[1]         # => "admin"
+
+Looker::COLORS["yellow"] # => "ffff00"
+Looker::COLORS["0000ff"] # => "blue"
+```
+
+## ActiveRecord enums
+
+You may find it useful to reuse Looker defined enumerated types as [ActiveRecord enums](http://api.rubyonrails.org/classes/ActiveRecord/Enum.html).
+
+Fortunately this is pretty simple— just use the `to_h` method on the Looker constant.
+
+```ruby
+Looker.add roles: {
+  :admin  => 1,
+  :reader => 2,
+  :writer => 3
+}
+
+class User < ActiveRecord::Base
+  enum roles: Looker::ROLES.to_h
+end
+```
+

data/lib/looker.rb

@@ -1,15 +1,29 @@
+require "forwardable"
 require "looker/version"
 require "looker/table"
 
 module Looker
-  def self.create_constants(data={})
-    data.each do |name, rows|
-      table = Looker::Table.new(name, rows)
-      if Looker.const_defined?(table.const_name)
-        message = "Looker::#{table.const_name} is already defined!"
-        raise ArgumentError.new(message)
+  extend Forwardable
+  include Enumerable
+  def_delegators :tables, :each
+
+  class << self
+
+    def tables
+      @tables ||= []
+    end
+
+    def add(data={})
+      data.each do |name, rows|
+        table = Looker::Table.new(name, rows)
+        if Looker.const_defined?(table.constant_name)
+          message = "Looker::#{table.constant_name} is already defined!"
+          raise ArgumentError.new(message)
+        end
+        Looker.const_set table.constant_name, table
+        tables << table
       end
-      Looker.const_set table.const_name, table
     end
+
   end
 end

data/lib/looker/table.rb

@@ -5,21 +5,28 @@ module Looker
     extend Forwardable
     include Enumerable
     def_delegators :rows, :each
-    def_delegator :dict, :[]
-    attr_reader :name, :const_name, :rows
+    attr_reader :name, :constant_name, :rows
 
     def self.constant_name(name)
-      name.to_s.gsub(/\s/, "_").gsub(/\W/, "").upcase
+      name.gsub(/\s/, "_").gsub(/\W/, "").upcase
     end
 
     def initialize(name, rows={})
-      @name = name.to_s.dup.freeze
-      @const_name = self.class.constant_name(name).freeze
+      @name = name.to_s.strip.freeze
+      @constant_name = self.class.constant_name(@name).freeze
       @rows = rows.dup.freeze
       @dict = rows.invert.merge(rows).freeze
       freeze
     end
 
+    def [](key)
+      dict[key] || dict[key.to_s] || dict[key.to_s.to_sym]
+    end
+
+    def to_h
+      rows
+    end
+
     private
 
     attr_reader :dict

data/lib/looker/version.rb

@@ -1,3 +1,3 @@
 module Looker
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: looker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Nathan Hopkins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-31 00:00:00.000000000 Z
+date: 2016-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler