facterdb 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b446e391aa35c93ef8b2344d8311594c1f31ca608b515026f8ccb3772a23f0e8
-  data.tar.gz: 848bce097609f4da2f5f39baddcabc820e11aff6e0a3c329f0db22df86aefb39
+  metadata.gz: d3c5507c6727a268578ec7d76730523df6fea54b3eb52c0bb5d3d4fd5dfd5eee
+  data.tar.gz: 99ee4c368b24f08a646a9d936507b07fcd1c71c38c202b704676055b4018b6d1
 SHA512:
-  metadata.gz: d11839665d133a84b6b78f3b3ce338c2d127787acbea80c861ad88c3ec69d55f20517d0e31aae323a5ec0f7ecb63efbde08b0aa66cb499001e6042911362583b
-  data.tar.gz: 13070c867414980285265492c7f0f56551c7adc901f7442a52b816ecd4e7674c8b58d800f710c13d4a1a0b6e1d2ddcf770470776a3efa4a9ce29e57992b9cd39
+  metadata.gz: b13f056772f354c139d0674121b3e7d249931b24ee67f7c71336e988276aa537a0e2e09859fecee7ccfe4d5a47c0b6ac7914cef20635a6afbbf4f53b4af8979f
+  data.tar.gz: 6c9b28b139fef0ecdc7e5003994882fb1996a32cfd641249960c60c4c65b909ee03e9e5083ed1286f1fb96b3666a96c7e773c18767bc70954a36df7efa748caa

data/.travis.yml

@@ -3,19 +3,27 @@ sudo: false
 cache: bundler
 script:
 - bundle exec rake spec
-rvm:
-- 2.3
-env:
-- FACTER_GEM_VERSION="~> 1.6.0"
-- FACTER_GEM_VERSION="~> 1.7.0"
-- FACTER_GEM_VERSION="~> 2.0.0"
-- FACTER_GEM_VERSION="~> 2.1.0"
-- FACTER_GEM_VERSION="~> 2.2.0"
-- FACTER_GEM_VERSION="~> 2.3.0"
-- FACTER_GEM_VERSION="~> 2.4.0"
-- FACTER_GEM_VERSION="~> 2.0" COVERAGE=yes
 matrix:
   fast_finish: true
+  include:
+  - rvm: 2.3
+    env: FACTER_GEM_VERSION="~> 1.6.0"
+  - rvm: 2.3
+    env: FACTER_GEM_VERSION="~> 1.7.0"
+  - rvm: 2.3
+    env: FACTER_GEM_VERSION="~> 2.0.0"
+  - rvm: 2.3
+    env: FACTER_GEM_VERSION="~> 2.1.0"
+  - rvm: 2.3
+    env: FACTER_GEM_VERSION="~> 2.2.0"
+  - rvm: 2.3
+    env: FACTER_GEM_VERSION="~> 2.3.0"
+  - rvm: 2.3
+    env: FACTER_GEM_VERSION="~> 2.4.0"
+  - rvm: 2.5
+    env: FACTER_GEM_VERSION="~> 2.0" COVERAGE=yes
+  - rvm: 2.7
+    env: FACTER_GEM_VERSION="~> 2.0"
 notifications:
   email: false
 deploy:

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [1.5.0](https://rubygems.org/gems/facterdb/versions/1.5.0) (2020-11-19)
+
+[Full Changelog](https://github.com/camptocamp/facterdb/compare/1.4.0...1.5.0)
+
+**Implemented enhancements:**
+
+- add filter validation [\#19](https://github.com/camptocamp/facterdb/issues/19)
+
+**Merged pull requests:**
+
+- Fixes a bug with generate\_filter\_str [\#160](https://github.com/camptocamp/facterdb/pull/160) ([logicminds](https://github.com/logicminds))
+- Fixes \#19 - add filter validation [\#159](https://github.com/camptocamp/facterdb/pull/159) ([logicminds](https://github.com/logicminds))
+- Remove pin on facter \< 4 [\#156](https://github.com/camptocamp/facterdb/pull/156) ([sanfrancrisko](https://github.com/sanfrancrisko))
+- Add ruby 2.5 and 2.7 testing [\#155](https://github.com/camptocamp/facterdb/pull/155) ([DavidS](https://github.com/DavidS))
+
 ## [1.4.0](https://rubygems.org/gems/facterdb/versions/1.4.0) (2020-05-09)
 
 [Full Changelog](https://github.com/camptocamp/facterdb/compare/1.3.0...1.4.0)
@@ -20,6 +35,7 @@
 
 - Add Debian 10 facter 3.13/3.14 sets [\#152](https://github.com/camptocamp/facterdb/pull/152) ([bastelfreak](https://github.com/bastelfreak))
 - Pin to facter \< 4 to avoid automatic upgrade [\#151](https://github.com/camptocamp/facterdb/pull/151) ([raphink](https://github.com/raphink))
+- Adding facts from Solaris 11 x86 & SPARC [\#149](https://github.com/camptocamp/facterdb/pull/149) ([genebean](https://github.com/genebean))
 - AmazonLinux facts added [\#147](https://github.com/camptocamp/facterdb/pull/147) ([bFekete](https://github.com/bFekete))
 - Add facts for Raspbian 9 and 10; alter Rakefile to support Raspbian [\#136](https://github.com/camptocamp/facterdb/pull/136) ([threepistons](https://github.com/threepistons))
 

data/README.md

@@ -2,7 +2,6 @@ facterdb
 ========
 
 [![Build Status](https://img.shields.io/travis/camptocamp/facterdb/master.svg)](https://travis-ci.org/camptocamp/facterdb)
-[![Code Climate](https://img.shields.io/codeclimate/github/camptocamp/facterdb.svg)](https://codeclimate.com/github/camptocamp/facterdb)
 [![Gem Version](https://img.shields.io/gem/v/facterdb.svg)](https://rubygems.org/gems/facterdb)
 [![Gem Downloads](https://img.shields.io/gem/dt/facterdb.svg)](https://rubygems.org/gems/facterdb)
 [![Coverage Status](https://img.shields.io/coveralls/camptocamp/facterdb.svg)](https://coveralls.io/r/camptocamp/facterdb?branch=master)

data/facterdb.gemspec

@@ -21,6 +21,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'pry'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'github_changelog_generator', '~> 1.10', '< 1.10.4'
-  s.add_runtime_dependency 'facter', '< 4.0.0'
+  s.add_runtime_dependency 'facter', '< 5.0.0'
   s.add_runtime_dependency 'jgrep'
 end

data/lib/facterdb.rb

@@ -2,6 +2,9 @@ require 'facter'
 require 'jgrep'
 
 module FacterDB
+  module Errors
+    class InvalidFilter < RuntimeError; end
+  end
 
   # @return [String] -  returns a giant incomprehensible string of concatenated json data
   def self.database
@@ -92,18 +95,36 @@ module FacterDB
     get_facts(filter_str)
   end
 
-  def self.get_facts(filter=nil)
-    if filter.is_a?(Array)
-      filter_str = '(' + filter.map { |f| f.map { |k,v | "#{k}=#{v}" }.join(' and ') }.join(') or (') + ')'
-    elsif filter.is_a?(Hash)
-      filter_str = filter.map { |k,v | "#{k}=#{v}" }.join(' and ')
-    elsif filter.is_a?(String)
-      filter_str = filter
-    elsif filter == nil
-      filter_str = ''
+  # @return [String] - the string filter
+  # @param filter [Object] - The filter to convert to jgrep string
+  def self.generate_filter_str(filter=nil)
+    case filter
+    when ::Array
+      '(' + filter.map { |f| f.map { |k,v | "#{k}=#{v}" }.join(' and ') }.join(') or (') + ')'
+    when ::Hash
+      filter.map { |k,v | "#{k}=#{v}" }.join(' and ')
+    when ::String
+      filter
+    when ::NilClass
+      ''
     else
-      raise 'filter must be either an Array a Hash or a String'
+      raise Errors::InvalidFilter, "filter must be either an Array a Hash, String, or nil, received #{filter.class}"
     end
+  end
+
+  # @return [Boolean] - true if the filter is valid against the jgrep filter validator
+  # @param filter [Object] - The filter to convert to jgrep string
+  def self.valid_filters?(filters)
+    filter_str = generate_filter_str(filters)
+    JGrep.validate_filters(filter_str).nil?
+  rescue RuntimeError
+    false
+  end
+
+  # @return [Array] - array of hashes of facts
+  # @param filter [Object] - The filter to convert to jgrep string
+  def self.get_facts(filter=nil)
+    filter_str = generate_filter_str(filter)
     JGrep.jgrep(database, filter_str).map { |hash| Hash[hash.map{ |k, v| [k.to_sym, v] }] }
   end
 end

data/lib/facterdb/version.rb

@@ -1,5 +1,5 @@
 module FacterDB
   module Version
-    STRING = '1.4.0'
+    STRING = '1.5.0'
   end
 end

data/spec/facterdb_spec.rb

@@ -282,6 +282,42 @@ describe FacterDB do
     end
   end
 
+  describe '.valid_filters?' do
+    it 'invalid and false' do
+      expect( FacterDB.valid_filters?('and')).to be_falsey
+    end
+
+    it 'valid and true' do
+      expect( FacterDB.valid_filters?('foo')).to be_truthy
+    end
+  end
+
+  describe '.generate_filter_str' do
+    it 'invalid type' do
+      expect{FacterDB.generate_filter_str(3)}.to raise_error(FacterDB::Errors::InvalidFilter)
+    end
+
+    it 'with string' do
+      expect(FacterDB.generate_filter_str('foo')).to eq("foo")
+    end
+
+    it 'with hash' do
+        expect(FacterDB.generate_filter_str({:osfamily => 'Debian'})).to eq("osfamily=Debian")
+    end
+
+    it 'with Array' do
+      expect(FacterDB.generate_filter_str([:osfamily => 'Debian'])).to eq("(osfamily=Debian)")
+    end
+
+    it 'empty' do
+      expect(FacterDB.generate_filter_str('')).to eq('')
+    end
+
+    it 'nil filter' do
+      expect(FacterDB.generate_filter_str(nil)).to eq('')
+    end
+  end
+
   describe '.get_facts' do
     subject(:result) { FacterDB.get_facts(filter) }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: facterdb
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Mickaël Canévet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-09 00:00:00.000000000 Z
+date: 2020-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls
@@ -92,14 +92,14 @@ dependencies:
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: jgrep
   requirement: !ruby/object:Gem::Requirement
@@ -1757,8 +1757,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: A Database of OS facts provided by Facter