incline 0.2.21 → 0.2.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53d73c77b134ead5f325b1df5a39dae0cf712617
-  data.tar.gz: 5de1a6150ce541052263e88a719148701a709c12
+  metadata.gz: 9a1e49384b7901f87a814ee60d71b0851ddc7f7b
+  data.tar.gz: 111391691fad01b40f655ee7cef3a998c1863068
 SHA512:
-  metadata.gz: 8cbf94c22ec5fcca8a59e0d01891d8399a04ecd21a3a90de1145f9e21a9eb8f1e5ce44bf59f6e795a6a88e44e92b5ba911dd78e7893e2377e9d6be900d0530d5
-  data.tar.gz: 3fe781aa459fdc03d1830b0ae4cee36e2ef4c6bd9b8acef262fd83363517f47aec8433f694b35cf4823f0ff9b9f6edf433a2b55e52d9bb05fe97541326946133
+  metadata.gz: 6fa77414d22418a5866ee05c1a3a6b4361ff2a4a48dfa889a63599999afb355503e492911e338f895490492ad132f02cc948c53eed0ac8917ef54a10fe37521b
+  data.tar.gz: c64ce83ca35c5132ba98e5e46f615327bddf7f00dbf4f523b510b7a0fe53118cbd97fafb66825124d08881a8fefbaeb5ced2dfb93a109891132a5287ed73f736

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    incline (0.2.21)
+    incline (0.2.22)
       ansi (~> 1.5.0)
       bcrypt
       bootstrap-sass

data/lib/incline/bit_enum.rb

@@ -0,0 +1,93 @@
+module Incline
+  class BitEnum < ConstantEnum
+    
+    def self.name_for(value, set_nil = false)
+      ret = values.select{|(v,k)| v == value}.map{|(v,k)| k}
+      return ret unless ret.blank?
+      
+      ret = []
+      
+      values.each do |(v,k)|
+        if v.power_of_2? && value >= v
+          if set_nil
+            ret << k || v.to_s
+          else
+            ret << k
+          end
+          value -= v
+        end
+      end
+      
+      if value > 0
+        ret << set_nil ? value.to_s : nil
+      end
+      
+      ret.sort
+    end
+    
+    def self.named?(value)
+      nm = name_for(value, false)
+      return false if nm.blank?
+      nm.select{|v| v.nil?}.blank?
+    end
+    
+    def to_s
+      self.class.name_for(value, true).join(' | ')
+    end
+    
+    ##
+    # Enable bit checking and bit setting/clearing.
+    # 
+    # For instance, with a constant FLAG_1, this enables :flag_1? and :flag_1=(true|false).
+    def method_missing(m,*a,&b)
+      name = m.to_s
+      if name[-1] == '?'
+        name = name[0...-1].upcase.to_sym
+        if constants(false).include?(name)
+          v = const_get(name)
+          return (value & v) == v
+        end
+      elsif name[-1] == '='
+        name = name[0...-1].upcase.to_sym
+        if constants(false).include?(name)
+          v = const_get(name)
+          if a[0]
+            value |= v
+          else
+            value &= ~v
+          end
+          @name = self.class.name_for(@value)
+          return a[0]
+        end
+      end
+      super m, *a, &b
+    end
+    
+    private
+    
+    def self.values
+      @values ||= 
+          begin
+            tmp = names.map{|k,v| [ v, k ]}.sort{|a,b| b[0] <=> a[0]}
+            max_bit = tmp.first[0]
+            unless max_bit.power_of_2?
+              pow = 1
+              while pow < max_bit
+                pow <<= 1
+              end
+              max_bit = pow >> 1
+            end
+            
+            while max_bit > 0
+              unless tmp.index{|(v,k)| v == max_bit}
+                tmp << [ max_bit, nil ]
+              end
+              max_bit >>= 1
+            end
+            
+            tmp.sort{|a,b| b[0] <=> a[0]}
+          end
+    end
+    
+  end
+end

data/lib/incline/constant_enum.rb

@@ -0,0 +1,40 @@
+module Incline
+  class ConstantEnum
+    
+    attr_reader :value, :name
+    
+    def initialize(value)
+      raise ArgumentError, 'Invalid value' unless self.class.named?(value)
+      @value = value
+      @name = self.class.name_for(value)
+    end
+    
+    def to_s
+      name
+    end
+    
+    
+    
+    def self.named?(value)
+      !name_for(value).blank?
+    end
+    
+    def self.name_for(value)
+      names.key(value) || ''
+    end
+    
+    private
+    
+    def self.names
+      @names ||=
+          begin
+            ret = {}
+            constants(false).each do |nm|
+              ret[nm.to_s] = const_get(nm)
+            end
+            ret
+          end
+    end
+    
+  end
+end

data/lib/incline/engine.rb

@@ -8,6 +8,8 @@ require 'incline/data_tables_request'
 require 'incline/recaptcha'
 require 'incline/auth_engine_base'
 require 'incline/user_manager'
+require 'incline/constant_enum'
+require 'incline/bit_enum'
 
 # Preloaded gems
 require 'rails'

data/lib/incline/extensions/numeric.rb

@@ -56,7 +56,13 @@ module Incline::Extensions
     def to_bool
       self != 0
     end
-
+    
+    ##
+    # Is this value a power of two?
+    def power_of_2?
+      (self.to_i == self) && (self != 0) && ((self & (self - 1)) == 0)
+    end
+    
   end
 end
 

data/lib/incline/version.rb

@@ -1,3 +1,3 @@
 module Incline
-  VERSION = "0.2.21"
+  VERSION = "0.2.22"
 end

data/test/lib/bit_enum_test.rb

@@ -0,0 +1,54 @@
+require 'test_helper'
+
+class BitEnumTest < ActiveSupport::TestCase
+  
+  class MyEnum < ::Incline::BitEnum
+    
+    # raw bits.
+    ALPHA = 1
+    BRAVO = 2
+    CHARLIE = 4
+    DELTA = 8
+    ECHO = 16
+    
+    # combined bits.
+    FOXTROT = 5
+    GOLF = 17
+    
+  end
+  
+  test 'should allow initialization' do
+    item = MyEnum.new(6)
+    assert item
+    assert_equal 6, item.value
+    assert_equal %w(BRAVO CHARLIE), item.name
+    assert_equal 'BRAVO | CHARLIE', item.to_s
+  end
+  
+  test 'should not allow invalid values' do
+    assert_raises(ArgumentError){ MyEnum.new(0) }
+    assert_raises(ArgumentError){ MyEnum.new(32) }
+  end
+  
+  test 'should allow valid values' do
+    assert MyEnum.new(1)
+    assert MyEnum.new(7)
+    assert MyEnum.new(15)
+    assert MyEnum.new(31)
+  end
+  
+  test 'should recognize names' do
+    assert MyEnum.named?(1)
+    assert MyEnum.named?(2)
+    assert MyEnum.named?(3)
+    assert MyEnum.named?(4)
+    assert MyEnum.named?(5)
+    assert_equal %w(ALPHA), MyEnum.name_for(1)
+    assert_equal %w(BRAVO), MyEnum.name_for(2)
+    assert_equal %w(ALPHA BRAVO), MyEnum.name_for(3)
+    assert_equal %w(CHARLIE), MyEnum.name_for(4)
+    assert_equal %w(FOXTROT), MyEnum.name_for(5)
+  end
+  
+  
+end

data/test/lib/constant_enum_test.rb

@@ -0,0 +1,43 @@
+require 'test_helper'
+
+class ConstantEnumTest < ActiveSupport::TestCase
+  
+  class MyEnum < ::Incline::ConstantEnum
+    
+    ALPHA = 1
+    BRAVO = 2
+    CHARLIE = 3
+    DELTA = 4
+    
+  end
+  
+  test 'should allow initialization' do
+    item = MyEnum.new(2)
+    assert item
+    assert_equal 2, item.value
+    assert_equal 'BRAVO', item.name
+    assert_equal item.name, item.to_s
+  end
+  
+  test 'should not allow invalid values' do
+    assert_raises ArgumentError do
+      MyEnum.new(0)
+    end
+    assert_raises ArgumentError do
+      MyEnum.new(5)
+    end
+  end
+  
+  test 'should be able to identify named values' do
+    assert MyEnum.named?(3)
+    assert_not MyEnum.named?(42)
+  end
+  
+  test 'should always return a non-nil name' do
+    assert_equal 'DELTA', MyEnum.name_for(4)
+    assert_equal '', MyEnum.name_for(100)
+  end
+  
+  
+  
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: incline
 version: !ruby/object:Gem::Version
-  version: 0.2.21
+  version: 0.2.22
 platform: ruby
 authors:
 - Beau Barker
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-17 00:00:00.000000000 Z
+date: 2017-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -395,6 +395,7 @@ files:
 - lib/generators/incline/templates/incline_version.rb
 - lib/incline.rb
 - lib/incline/auth_engine_base.rb
+- lib/incline/bit_enum.rb
 - lib/incline/cli.rb
 - lib/incline/cli/errors.rb
 - lib/incline/cli/helpers/yaml.rb
@@ -416,6 +417,7 @@ files:
 - lib/incline/cli/prepare/update_system.rb
 - lib/incline/cli/usage.rb
 - lib/incline/cli/version.rb
+- lib/incline/constant_enum.rb
 - lib/incline/data_tables_request.rb
 - lib/incline/date_time_formats.rb
 - lib/incline/engine.rb
@@ -562,6 +564,8 @@ files:
 - test/integration/incline/users_login_test.rb
 - test/integration/incline/users_signup_test.rb
 - test/integration/navigation_test.rb
+- test/lib/bit_enum_test.rb
+- test/lib/constant_enum_test.rb
 - test/lib/data_tables_request_test.rb
 - test/lib/date_time_formats_test.rb
 - test/lib/global_status_test.rb
@@ -606,7 +610,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A gem designed to get off to an even quicker start with Rails.