frenchy 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bbd873ca7bf47ce23e6e60450167777221a970c4
-  data.tar.gz: b482ca20c727d4ebad679da013405e15e260bd37
+  metadata.gz: c053d86535fc11bfb4789c95b7a3207089b81a3e
+  data.tar.gz: 99f313562478d7607816b095e176fef88d2fdeed
 SHA512:
-  metadata.gz: e477ae25b9c358cf9ad06d3b1816720ef0da7b81666cda78c0780d9275dd9fabb8592b492a2a251e1e54ed49e8b1146606e431aedae18f42b688f4e9e246116c
-  data.tar.gz: aa04396f718b9523f060e6d29913c2c8601466f580fa9de1855bd6e3f0067d9d6c8f9dd69372edae0b21e01c83fea219065f27b4dbf5f26f3368e112118bd713
+  metadata.gz: 8da2c669175476f793dad871f7e737e1b65b89a4c98dca7582e0d23b3f9f63633ad56c2e343cacef2452acc6d53755d6e8bd7d505f4a0d813722747494253f5f
+  data.tar.gz: 77ef9f74818af9c594d721f270ac1fcde31433e43204a636a979426f4a9ea7f7995e0fea7601ccda015df669fc642b74f37f0995f2bf3ef13b6f668bbd3d64a9

data/lib/frenchy.rb

@@ -2,6 +2,7 @@ require "frenchy/core_ext"
 
 require "frenchy/client"
 require "frenchy/collection"
+require "frenchy/enum"
 require "frenchy/error"
 require "frenchy/instrumentation"
 require "frenchy/model"

data/lib/frenchy/enum.rb

@@ -0,0 +1,71 @@
+module Frenchy
+  module Enum
+    def self.included(base)
+      base.extend(ClassMethods)
+
+      base.class_eval do
+        @enums = {}
+        @default = nil
+      end
+    end
+
+    attr_accessor :name, :tag
+
+    def initialize(attrs={})
+      attrs.each do |k, v|
+        send("#{k}=", v) if respond_to?("#{k}=")
+      end
+    end
+
+    def inspect
+      "\#<#{self.class.name}::#{name}=#{tag}>"
+    end
+
+    def to_i
+      tag
+    end
+
+    def to_str
+      to_s
+    end
+
+    def to_sym
+      name
+    end
+
+    def to_s
+      name.to_s.underscore
+    end
+
+    def ==(other)
+      (other.is_a?(Symbol) && (name == other)) ||
+      (other.respond_to?(:to_i) && (other.to_i == tag)) ||
+      (other.respond_to?(:to_s) && (other.to_s == to_s || other.to_s == name.to_s)) ||
+      super
+    end
+
+    module ClassMethods
+      def define(name, tag, options={})
+        name = name.to_sym
+        tag = tag.to_i
+        options.stringify_keys!
+
+        enum = new(name: name, tag: tag)
+        const_set(name, enum)
+        @enums[tag] = enum
+
+        if options["default"]
+          @default = tag
+        end
+      end
+
+      def default
+        @enums[@default]
+      end
+
+      def find(tag)
+        @enums[tag.to_i] || default
+      end
+    end
+  end
+end

data/lib/frenchy/model.rb

@@ -77,6 +77,15 @@ module Frenchy
         klass.class_eval(&block)
       end
 
+      # Macro to add an enum type
+      def enum(name, &block)
+        klass = Class.new(self) do
+          include Frenchy::Enum
+        end
+        const_set(name.to_s.camelize, klass)
+        klass.class_eval(&block)
+      end
+
       # Macro to create a subtype and associated field
       def embed(name, options={}, &block)
         type(name, &block)
@@ -88,6 +97,11 @@ module Frenchy
         name = name.to_s
         options.stringify_keys!
 
+        if options["enum"]
+          options["type"] = "enum"
+          options["class_name"] ||= options["enum"].to_s.camelize
+        end
+
         type = (options["type"] || "string").to_s
         aliases = (options["aliases"] || [])
 
@@ -160,6 +174,15 @@ module Frenchy
             set(name, Hash[v])
           end
 
+        when "enum"
+          # Resolve the class name
+          klass = const_get(options["class_name"])
+
+          # Convert value to enum class
+          define_method("#{name}=") do |v|
+            set(name, klass.find(v.to_i))
+          end
+
         else
           # Unknown types have their type constantized and initialized with the value. This
           # allows us to support things like other Frenchy::Model classes, ActiveRecord models, etc.

data/lib/frenchy/version.rb

@@ -1,3 +1,3 @@
 module Frenchy
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/spec/lib/frenchy/enum_spec.rb

@@ -0,0 +1,114 @@
+require "spec_helper"
+
+class SimpleEnum
+  include Frenchy::Enum
+
+  define :NONE,    0
+  define :PARTIAL, 1
+  define :FULL,    2
+end
+
+class EnumWithDefault
+  include Frenchy::Enum
+
+  define :NONE,             0
+  define :PARTIAL_SUPPORT,  1
+  define :FULL_SUPPORT,     2, default: true
+end
+
+describe Frenchy::Enum do
+  describe ".default" do
+    it "returns the default if set" do
+      e = EnumWithDefault.default
+      expect(e).to eql(EnumWithDefault::FULL_SUPPORT)
+    end
+
+    it "returns nil if not set" do
+      e = SimpleEnum.default
+      expect(e).to eql nil
+    end
+  end
+
+  describe ".find" do
+    it "finds by tag" do
+      e = SimpleEnum.find(1)
+      expect(e).to be_an_instance_of(SimpleEnum)
+      expect(e.tag).to eql(1)
+      expect(e.name).to eql(:PARTIAL)
+    end
+
+    it "returns nil when no match is found" do
+      e = SimpleEnum.find(5)
+      expect(e).to eql(nil)
+    end
+
+    it "returns default when no match is found and a default is declared" do
+      e = EnumWithDefault.find(5)
+      expect(e).to be_an_instance_of(EnumWithDefault)
+      expect(e.tag).to eql(2)
+      expect(e.name).to eql(:FULL_SUPPORT)
+    end
+  end
+
+  describe "constants" do
+    it "declares constants" do
+      e = SimpleEnum::PARTIAL
+      expect(e).to be_an_instance_of(SimpleEnum)
+      expect(e.tag).to eql(1)
+      expect(e.name).to eql(:PARTIAL)
+
+      e = SimpleEnum::FULL
+      expect(e).to be_an_instance_of(SimpleEnum)
+      expect(e.tag).to eql(2)
+      expect(e.name).to eql(:FULL)
+    end
+  end
+
+  describe "model" do
+    it "describes itself" do
+      e = SimpleEnum::FULL
+      expect(e.inspect).to eql "\#<SimpleEnum::FULL=2>"
+    end
+
+    it "== compares equality" do
+      e = SimpleEnum::FULL
+      e2 = EnumWithDefault::FULL_SUPPORT
+      f = SimpleEnum::PARTIAL
+
+      # Separate reference
+      expect(e == SimpleEnum::FULL).to eql(true)
+
+      # Comparison by enum
+      expect(e == e).to eql(true)
+
+      # Comparison across enum types
+      expect(e == e2).to eql(true)
+      expect(e == f).to eql(false)
+
+      # Comparison by tag
+      expect(e == 2).to eql(true)
+      expect(2 == e).to eql(true)
+
+      # Comparison by string
+      expect(e == "full").to eql(true)
+      expect("full" == e).to eql(true)
+      expect(e == "FULL").to eql(true)
+      expect("FULL" == e).to eql(true)
+    end
+
+    it "#to_i returns the tag" do
+      e = SimpleEnum::FULL
+      expect(e.to_i).to eql(2)
+    end
+
+    it "#to_s returns a lowercase name" do
+      e = SimpleEnum::FULL
+      expect(e.to_s).to eql("full")
+    end
+
+    it "#to_s returns underscore names" do
+      e = EnumWithDefault::FULL_SUPPORT
+      expect(e.to_s).to eql("full_support")
+    end
+  end
+end

data/spec/lib/frenchy/model_spec.rb

@@ -23,6 +23,12 @@ end
 class Box
   include Frenchy::Model
 
+  enum :priority do
+    define :NORMAL,    0, default: true
+    define :PRIORITY,  1
+    define :EXPRESS,   2
+  end
+
   class SubclassItem
     include Frenchy::Model
 
@@ -53,6 +59,9 @@ class Box
   field :special, type: "special_item", class_name: "SuperSpecialItem"
   field :subclass, type: "subclass_item"
   field :subtype, type: "subtype_item"
+
+  field :priority, enum: "priority"
+  field :other_priority, enum: "priority", default: Priority::NORMAL
 end
 
 class SimpleModelDecorator
@@ -234,6 +243,28 @@ describe Frenchy::Model do
       end
     end
 
+    describe "enum" do
+      it "defaults to the default" do
+        v = Box.new
+        expect(v.priority).to eql(nil)
+        expect(v.other_priority).to eql(Box::Priority::NORMAL)
+      end
+
+      it "accepts fixnums" do
+        v = Box.new(priority: 2)
+        expect(v.priority).to eql(Box::Priority::EXPRESS)
+        expect(v.priority.to_i).to eql(2)
+        expect(v.priority.to_s).to eql("express")
+      end
+
+      it "accepts enums" do
+        v = Box.new(priority: Box::Priority::PRIORITY)
+        expect(v.priority).to eql(Box::Priority::PRIORITY)
+        expect(v.priority.to_i).to eql(1)
+        expect(v.priority.to_s).to eql("priority")
+      end
+    end
+
     describe "model relationships" do
       it "establishes single model relationships" do
         v = Box.new(item: {id: 1}).item

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frenchy
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jason Coene
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-25 00:00:00.000000000 Z
+date: 2016-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -142,6 +142,7 @@ files:
 - lib/frenchy/client.rb
 - lib/frenchy/collection.rb
 - lib/frenchy/core_ext.rb
+- lib/frenchy/enum.rb
 - lib/frenchy/error.rb
 - lib/frenchy/instrumentation.rb
 - lib/frenchy/model.rb
@@ -152,6 +153,7 @@ files:
 - spec/lib/frenchy/client_spec.rb
 - spec/lib/frenchy/collection_spec.rb
 - spec/lib/frenchy/core_ext_spec.rb
+- spec/lib/frenchy/enum_spec.rb
 - spec/lib/frenchy/error_spec.rb
 - spec/lib/frenchy/model_spec.rb
 - spec/lib/frenchy/request_spec.rb
@@ -187,6 +189,7 @@ test_files:
 - spec/lib/frenchy/client_spec.rb
 - spec/lib/frenchy/collection_spec.rb
 - spec/lib/frenchy/core_ext_spec.rb
+- spec/lib/frenchy/enum_spec.rb
 - spec/lib/frenchy/error_spec.rb
 - spec/lib/frenchy/model_spec.rb
 - spec/lib/frenchy/request_spec.rb