render-text-helper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9fa3bf802a34b87ba97a5adde26041af9da76aa1897a6cb671e5d3f854e87bb7
+  data.tar.gz: 7e3acb894a0defcfb02e07bb8eb16b4c1b1ebabe2374f4f147c5b7f15f9f1b71
+SHA512:
+  metadata.gz: 90167a134c6dab5ee393ddffd1e9e2833b40692d54c733572c47b2edd2c6a796ba6a978c58aec2282370a1afeb88cf28eeda4fbc30578e7a33df133c58566877
+  data.tar.gz: 66291f7ae3b137077a43b84836e8bbcfc608bed12ba2ab6152daadb6842d4058fea352bdac6d54dd49b25fa29a9311a7b9a7e9d07e88b4dce0932885129de8d5

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## Changelog
+
+## [0.1.0] - 2022-08-14
+
+- Initial release
+- Added function: to_yn
+- Added function: to_yes_no
+- Added function: limit_print

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in render-text-helper.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'rspec', '~> 3.0'
+
+gem 'rubocop', '~> 1.21'

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    render-text-helper (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    json (2.6.2)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.35.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.2.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  rake (~> 13.0)
+  render-text-helper!
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.3.20

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Saimon Lovell
+
+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

@@ -0,0 +1,79 @@
+# Render::Text::Helper
+
+This gem extends text manipulation to classes like String, Boolean etc..
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add render-text-helper
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install render-text-helper
+
+## Usage
+
+### Limit Print
+
+This function makes sure that the string does not go over a specific given limit.
+It has two parameters "limit" which is defaulted to 32 and "more_indicator" which
+defaults to "."
+
+```ruby
+'hello'.limit_print
+'hello'
+
+'elephant'.limit_print(limit: 2)
+'el...'
+
+'elephant'.limit_print(limit: 2, more_indicator: '')
+'el'
+
+'elephant'.limit_print(limit: 3, more_indicator: '_')
+'ele___'
+```
+
+### to yes no
+
+This function returns a string from a boolean to yes or no.
+
+```ruby
+true.to_yes_no
+'yes'
+
+true.to_yes_no(capital_letter: true)
+'YES'
+
+false.to_yes_no
+'no'
+
+false.to_yes_no(capital_letter: true)
+'NO'
+```
+
+### to yn
+
+This function returns a string from a boolean to Y or N
+
+```ruby
+true.to_yn
+'Y'
+
+true.to_yn(capital_letter: false)
+'y'
+
+false.to_yn
+'N'
+
+false.to_yn(capital_letter: false)
+'n'
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/SaimonL/render-text-helper
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/render/text/helper/boolean.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# Added methods to boolean module
+module BooleanHelper
+  def to_yn(capital_letter: true)
+    if self
+      capital_letter ? 'Y' : 'y'
+    else
+      capital_letter ? 'N' : 'n'
+    end
+  end
+
+  def to_yes_no(capital_letter: false)
+    if self
+      capital_letter ? 'YES' : 'yes'
+    else
+      capital_letter ? 'NO' : 'no'
+    end
+  end
+end
+
+class TrueClass
+  include BooleanHelper
+end
+
+class FalseClass
+  include BooleanHelper
+end

data/lib/render/text/helper/string.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Adds function to existing String class
+class String
+  # output the string giving the limit. It does not touch the string
+  def limit_print(limit: 32, more_indicator: '.')
+    return self if size < limit
+
+    [self[0...limit], more_indicator, more_indicator, more_indicator].join
+  end
+end

data/lib/render/text/helper/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Render
+  module Text
+    module Helper
+      VERSION = '0.1.0'
+    end
+  end
+end

data/lib/render/text/helper.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative 'helper/version'
+require_relative 'helper/string'
+require_relative 'helper/boolean'
+
+module Render
+  module Text
+    module Helper
+      class Error < StandardError; end
+      # Your code goes here...
+    end
+  end
+end

data/render-text-helper.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'lib/render/text/helper/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'render-text-helper'
+  spec.version = Render::Text::Helper::VERSION
+  spec.authors = ['Saimon Lovell']
+  spec.email = ['staysynchronize@gmail.com']
+
+  spec.summary = 'Does some string malnutrition'
+  spec.description = 'Limit the render text, convert boolean to text etc'
+  spec.homepage = 'https://github.com/SaimonL/render-text-helper'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/SaimonL/render-text-helper'
+  spec.metadata['changelog_uri'] = 'https://github.com/SaimonL/render-text-helper/blob/master/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/render/text/helper/boolean.rbs

@@ -0,0 +1,17 @@
+module Render
+  module Text
+    module Helper
+      class TrueClass
+        def to_yn: (capital_letter: bool) -> String
+
+        def to_yes_no: (capital_letter: bool) -> String
+      end
+
+      class FalseClass
+        def to_yn: (capital_letter: bool) -> String
+
+        def to_yes_no: (capital_letter: bool) -> String
+      end
+    end
+  end
+end

data/sig/render/text/helper/string.rbs

@@ -0,0 +1,9 @@
+module Render
+  module Text
+    module Helper
+      class String
+        def limit_print: (limit: Integer, more_indicator: String) -> String
+      end
+    end
+  end
+end

data/sig/render/text/helper.rbs

@@ -0,0 +1,8 @@
+module Render
+  module Text
+    module Helper
+      VERSION: String
+      # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+    end
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: render-text-helper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Saimon Lovell
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-08-15 00:00:00.000000000 Z
+dependencies: []
+description: Limit the render text, convert boolean to text etc
+email:
+- staysynchronize@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/render/text/helper.rb
+- lib/render/text/helper/boolean.rb
+- lib/render/text/helper/string.rb
+- lib/render/text/helper/version.rb
+- render-text-helper.gemspec
+- sig/render/text/helper.rbs
+- sig/render/text/helper/boolean.rbs
+- sig/render/text/helper/string.rbs
+homepage: https://github.com/SaimonL/render-text-helper
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/SaimonL/render-text-helper
+  source_code_uri: https://github.com/SaimonL/render-text-helper
+  changelog_uri: https://github.com/SaimonL/render-text-helper/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.20
+signing_key:
+specification_version: 4
+summary: Does some string malnutrition
+test_files: []