jekyll-truthyfalsy 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce20b2ad4b91bbcae45e649b66cb31506e7c9f2b9ca1d1bd3fd29b7132a54980
-  data.tar.gz: 5b9c9746e46603ea6393f026b9f2eb5da1114bd49f341d816b178b5bf90c44ac
+  metadata.gz: dfea5b16fc9b87be39842ea2b737d73f12704d15f9494af8fb5e9c6369349536
+  data.tar.gz: 675fc5000ab5ac2fb897067fb5ed6d2baf116f67208274947011b7ee80cb819d
 SHA512:
-  metadata.gz: 16c6dc347856c809dee82994c644a5bd55b1558fa8a280ae89458ca9d9675fe1405c2122f103c31e3ae9f0afb9c362293cf96e38af5f424cfcfc82644219819b
-  data.tar.gz: 607519dad1b36fc87a045b83684c9abc84e2d3512366d980618869d6908a22f159589d7bb96730dbafffe9896e3d10d2f0433b2b27a2719e278ca57f93eb446a
+  metadata.gz: 44880789333e1af31f786e9b8bac5c298b91371f16d1195ed24f8e34928072f2a117a13b13b1d5db4555907435598dd8708ca9f8cdf51f03fc40249eabbd14d7
+  data.tar.gz: d9cbb6c6c2652a4e924ce4899d8ac709db058b026320fa15855cf05f0fc5094d08959cb62cfaf645f1e05646731e8f989e121efa17cefdc34202a76dc256a220

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in jekyll-truthyfalsy.gemspec
+gemspec
+
+if ENV["JEKYLL_VERSION"]
+  gem "jekyll", "~> #{ENV["JEKYLL_VERSION"]}"
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 ITW Creative Works
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -33,7 +33,6 @@ Yes, this module works in both Node and browser environments, including compatib
 * Exposes a `isfalsy` function
 
 # Jekyll::truthyfalsy
-
 Meet `jekyll-truthyfalsy`, the whimsical gem dedicated to turning the grey areas of truthiness and falsiness into black and white. 
 
 It doesn't just settle for mere booleans; oh no, it goes above and beyond, scrutinizing empty strings and null values too! Like a tenacious detective, it leaves no stone unturned, and no value unverified. Banish the verbose 'if' statements and welcome a new era of compact, expressive checks. 
@@ -41,44 +40,77 @@ It doesn't just settle for mere booleans; oh no, it goes above and beyond, scrut
 Because life is too short for ambiguity, embrace the certainty that comes with `jekyll-truthyfalsy`. Truthiness and falsiness: not just a philosophical quandary, but a .gem installation away!
 
 ## Installation
-
 Install the gem and add to the application's Gemfile by executing:
 ```shell
-$ bundle add jekyll-truthyfalsy
+bundle add jekyll-truthyfalsy
 ```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 ```shell
-$ gem install jekyll-truthyfalsy
+gem install jekyll-truthyfalsy
 ```
 
 ## Usage
-Now you can use the istruthy and isfalsy filters in your Jekyll site's templates:
+Now you can use the `istruthy` and `isfalsy` filters in your Jekyll site's templates:
 
 ```liquid
-{% if page.title | istruthy %}
-  <h1>{{ page.title }}</h1>
-{% else %}
-  <h1>Untitled</h1>
-{% endif %}
-
-{% if page.description | isfalsy %}
-  <p>No description available</p>
-{% else %}
-  <p>{{ page.description }}</p>
-{% endif %}
+{%- assign test_true = true | istruthy -%}
+{%- if test_true -%}
+  This will print because `true` is truthy
+{%- endif -%}
+
+{%- assign test_false = false | istruthy -%}
+{%- if test_false -%}
+  This will NOT print because `false` is falsy
+{%- endif -%}
+
+{%- assign test_string = 'hi' | istruthy -%}
+{%- if test_string -%}
+  This will print because `'hi'` is truthy
+{%- endif -%}
+
+{%- assign test_empty_string = '' | istruthy -%}
+{%- if test_empty_string -%}
+  This will NOT print because `''` is falsy
+{%- endif -%}
+
+{%- assign test_null = null | istruthy -%}
+{%- if test_null -%}
+  This will NOT print because `null` is falsy
+{%- endif -%}
+
+{%- assign test_zero = 0 | istruthy -%}
+{%- if test_zero -%}
+  This will NOT print because `0` is falsy
+{%- endif -%}
+
+{%- assign test_one = 1 | istruthy -%}
+{%- if test_one -%}
+  This will print because `1` is truthy
+{%- endif -%}
 ```
 
 These examples show how you can use `istruthy` and `isfalsy` to easily check if a variable is "truthy" (not null, not an empty string, and not false) or "falsy" (null, an empty string, or false), respectively.
 
-No more long, confusing, multi-condition 'if' statements - just simple, readable code!
+No more long, confusing, multi-condition `if` statements - just simple, readable code!
 
 ## Development
-
 After checking out the repo, run `bin/setup` to install dependencies. 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-## Contributing
+### Building and pushing
+Run the tests
+```shell
+bundle exec rspec
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jekyll-truthyfalsy.
+Publish the Gem
+```shell
+gem build jekyll-truthyfalsy.gemspec
+
+gem push jekyll-truthyfalsy-1.0.0.gem
+```
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/itw-creative-works/jekyll-truthyfalsy.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/jekyll-truthyfalsy.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll-truthyfalsy/version'
+
+Gem::Specification.new do |spec|
+  # Gem info
+  spec.name = "jekyll-truthyfalsy"
+  spec.version = Jekyll::TruthyFalsy::VERSION
+
+  # Author info
+  spec.authors = ["ITW Creative Works"]
+  spec.email = ["hello@itwcreativeworks.com"]
+
+  # Gem details
+  spec.summary = "A Jekyll plugin that adds JavaScript-like truthy and falsy checks"
+  spec.description = "A simple Jekyll plugin that adds JavaScript-like istruthy and isfalsy filters to Liquid"
+  spec.homepage = "https://github.com/itw-creative-works/jekyll-truthyfalsy"
+  spec.license = "MIT"
+
+  # Files
+  spec.files = Dir["CODE_OF_CONDUCT.md", "README*.md", "LICENSE", "Rakefile", "*.gemspec", "Gemfile", "lib/**/*", "spec/**/*"]
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  # Gem requires Jekyll to work
+  spec.add_runtime_dependency "jekyll", ">= 3.0", "< 5.0"
+
+  # Development requires more
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+  # Ruby version
+  spec.required_ruby_version = ">= 2.0.0"
+end

data/lib/jekyll-truthyfalsy/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module TruthyFalsy
+    VERSION = "1.0.2"
+  end # module TruthyFalsy
+end # module Jekyll

data/lib/jekyll-truthyfalsy.rb

@@ -0,0 +1,15 @@
+require "jekyll"
+
+module Jekyll
+  module TruthyFalsy
+    def istruthy(input)
+      !(input.nil? || input == '' || input == false || input == 0)
+    end
+
+    def isfalsy(input)
+      input.nil? || input == '' || input == false || input == 0
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::TruthyFalsy)

data/spec/jekyll-truthyfalsy_spec.rb

@@ -0,0 +1,72 @@
+require 'jekyll-truthyfalsy'
+
+RSpec.describe Jekyll::TruthyFalsy do
+  # Dummy class to include the filter methods
+  class DummyClass
+    include Jekyll::TruthyFalsy
+  end
+
+  let(:dummy) { DummyClass.new }
+
+  # Truthy values
+  describe '.istruthy' do
+    it 'returns true for non-empty string' do
+      expect(dummy.istruthy('hello')).to be(true)
+    end
+
+    it 'returns false for empty string' do
+      expect(dummy.istruthy('')).to be(false)
+    end
+
+    it 'returns true for true boolean' do
+      expect(dummy.istruthy(true)).to be(true)
+    end
+
+    it 'returns false for false boolean' do
+      expect(dummy.istruthy(false)).to be(false)
+    end
+
+    it 'returns false for nil' do
+      expect(dummy.istruthy(nil)).to be(false)
+    end
+
+    it 'returns true for integer 1' do
+      expect(dummy.istruthy(1)).to be(true)
+    end
+
+    it 'returns false for integer 0' do
+      expect(dummy.istruthy(0)).to be(false)
+    end
+  end
+  
+  # Falsy values
+  describe '.isfalsy' do
+    it 'returns false for non-empty string' do
+      expect(dummy.isfalsy('hello')).to be(false)
+    end
+
+    it 'returns true for empty string' do
+      expect(dummy.isfalsy('')).to be(true)
+    end
+
+    it 'returns false for true boolean' do
+      expect(dummy.isfalsy(true)).to be(false)
+    end
+
+    it 'returns true for false boolean' do
+      expect(dummy.isfalsy(false)).to be(true)
+    end
+
+    it 'returns true for nil' do
+      expect(dummy.isfalsy(nil)).to be(true)
+    end
+
+    it 'returns false for integer 1' do
+      expect(dummy.isfalsy(1)).to be(false)
+    end
+
+    it 'returns true for integer 0' do
+      expect(dummy.isfalsy(0)).to be(true)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-truthyfalsy
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - ITW Creative Works
@@ -30,6 +30,48 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: 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'
 description: A simple Jekyll plugin that adds JavaScript-like istruthy and isfalsy
   filters to Liquid
 email:
@@ -38,8 +80,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- LICENSE
 - README.md
-- lib/jekyll/filters/truthyfalsy.rb
+- Rakefile
+- jekyll-truthyfalsy.gemspec
+- lib/jekyll-truthyfalsy.rb
+- lib/jekyll-truthyfalsy/version.rb
+- spec/jekyll-truthyfalsy_spec.rb
 homepage: https://github.com/itw-creative-works/jekyll-truthyfalsy
 licenses:
 - MIT
@@ -52,7 +100,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -63,4 +111,5 @@ rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: A Jekyll plugin that adds JavaScript-like truthy and falsy checks
-test_files: []
+test_files:
+- spec/jekyll-truthyfalsy_spec.rb

data/lib/jekyll/filters/truthyfalsy.rb

@@ -1,13 +0,0 @@
-module Jekyll
-  module IstruthyFalsyFilter
-    def istruthy(input)
-      !(input.nil? || input == '' || input == false)
-    end
-
-    def isfalsy(input)
-      input.nil? || input == '' || input == false
-    end
-  end
-end
-
-Liquid::Template.register_filter(Jekyll::IstruthyFalsyFilter)