toberead 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1cf4a0ee4acdf5e66a8ae444c90fa4c22fbced6a9842e796520577cdc5156ea6
+  data.tar.gz: c2caa689ef14600f9fd22ee831319c80666b04d6047509658dff932c54b9442e
+SHA512:
+  metadata.gz: 94ae9c12d2dd766ba9204212b900e9d9c4752906436a05bd1e0239aedd80b8377af446337dc57cb65e0b82359d582459db7566a70514266ea9515d103bd90989
+  data.tar.gz: a83a0f41335c1b52617eba960db33a19cd3aa9846bda905c4628674c94cda716a8449c097b2291799a581870dc0281ad0b541420611e8eb13870ab12d306a16b

data/.gitignore

@@ -0,0 +1,70 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+Gemfile.lock
+
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

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

data/.ruby-version

@@ -0,0 +1 @@
+3.0.2

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 3.0.2
+before_install: gem install bundler -v 2.2.22

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.7"

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 ChronoSerrano
+
+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,40 @@
+# ToBeRead
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/toberead`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'toberead'
+```
+
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install toberead
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/toberead.
+
+## 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/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "toberead"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/tbr

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "titleize"
+require "erb"
+require "yaml"
+require "toberead"
+
+prompts = ToBeRead::Deck.new("prompts")
+answers = ToBeRead::Deck.new("answers")
+puts [prompts.shuffle, answers.shuffle].join(": ")

data/lib/toberead/decks.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ToBeRead
+  class Deck
+    def initialize(deck_type)
+      @deck = ERB.new(
+        File.read(
+          File.join(ToBeRead.template_dir, "#{deck_type}.erb")
+        )
+      ).result(binding).split("\n")
+    end
+
+    def shuffle
+      @deck.sample.downcase.titleize
+    end
+  end
+end

data/lib/toberead/properties.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ToBeRead
+  class Property
+    class << self
+      def select(property)
+        properties = YAML.safe_load(load_template)
+        abort("Unknown property: #{property}") unless properties.key? property.to_s
+        properties[property.to_s].sample
+      end
+
+      private
+
+      def load_template
+        @load_template ||= ERB.new(
+          File.read(
+            File.join(ToBeRead.template_dir, "properties.yaml.erb")
+          )
+        ).result(binding)
+      end
+    end
+  end
+end

data/lib/toberead/templates/answers.erb

@@ -0,0 +1,48 @@
+IS A 5 STAR PREDICTION.    
+OWNED FOR THE LONGEST TIME.    
+HAS SOMETHING SHINY ON IT.    
+FOR THE COVER.    
+IS OUTSIDE MY USUAL COMFORT ZONE.    
+HAS THE <%=Property.select(:most_least)%> AMOUNT OF PAGES OF ALL THE ONES ON MY T.B.R.     
+IS A SEQUEL TO A BOOK I’VE READ.    
+STARTS WITH THE LETTER... <%=Property.select(:letter)%>.    
+HAS AN AUTHOR WHOSE <%=Property.select(:first_last)%> NAME STARTS WITH THE LETTER... <%=Property.select(:letter)%>.
+HAS/IS A <%=Property.select(:author_type)%> AUTHOR.    
+IS A BOOK CLUB PICK.    
+IS CONSIDERED A CLASSIC.    
+I DO NOT OWN PHYSICALLY YET.    
+HAS A TITLE OF <%=Property.select(:title_word_count)%> WORD(S).      
+I PICK AT RANDOM FROM MY GOODREADS T.B.R. LIST.
+I ASK A FRIEND TO PICK OUT OF 5.
+WITHOUT KNOWING MUCH ABOUT THE STORY.
+I PICK AT RANDOM FROM MY PHYSICAL BOOKSHELVES (RANDOMIZED NUMBER).
+I REALLY WANT TO READ RIGHT NOW.
+I’M MOST EXCITED TO READ THIS MONTH.
+HAS <%=Property.select(:color)%> ON IT.
+IS THE <%=Property.select(:old_new)%> ON MY T.B.R.
+IS THE <%=Property.select(:high_low)%> RATED ON MY T.B.R.
+IS SET IN THE <%=Property.select(:past_future)%>.
+I ALMOST GOT RID OF.
+I WILL SWAP FOR UNHAULING ONE BOOK (ONE IN, ONE OUT).
+IS THE SAME AS / SIMILAR TO THE LAST ONE I READ.
+IS A GUILTY PLEASURE (RE- READ, HISTORICAL ROMANCE, EASY/ FAST READ).
+MATCHES MY OUTFIT.
+I THINK A FRIEND WOULD ENJOY.
+I’VE READ BEFORE.
+OUT OF FEAR OF MISSING OUT.
+WAS INSPIRED BY A <%=Property.select(:source)%> recommendation.
+STARTS WITH ONE OF MY INITIALS.
+IS ILLUSTRATED.
+IS TYPOGRAPHIC.
+IS PHOTOGRAPHIC.
+BOUGHT LAST.
+IS THE FIRST OF A NEW SERIES.
+WITH A FRIEND.
+HAS A <%=Property.select(:setting)%> setting.
+HAS A <%=Property.select(:trope)%> trope.
+Is <%=Property.select(:length)%> pages long.
+Has a publication Year of <%=Property.select(:year)%>.
+Was obtained <%=Property.select(:year)%>.
+has a/an <%=Property.select(:on_the_cover)%> on the cover.
+has <%=Property.select(:representation)%> representation.
+is about/includes <%=Property.select(:topic)%>.

data/lib/toberead/templates/prompts.erb

@@ -0,0 +1,6 @@
+A BOOK THAT/WHICH
+A <%= Property.select(:genre) %> NOVEL THAT/WHICH
+A <%= Property.select(:item_type) %> THAT/WHICH
+A GENRE THAT/WHICH
+AN AUTHOR WHO/THAT
+A BOOK I BOUGHT

data/lib/toberead/templates/properties.yaml.erb

@@ -0,0 +1,56 @@
+---
+letter: <%= ('A'..'Z').to_a %>
+color:
+  - red
+  - yellow
+  - blue
+  - brown
+  - orange
+  - green
+  - black
+  - pink
+  - white
+  - gray
+  - purple
+high_low: ['highest', 'lowest']
+old_new: ['oldest', 'newest']
+most_least: ['most', 'least']
+past_future: ['past', 'future']
+genre:
+  - romance
+  - fantasy
+  - contemporary
+  - adult
+  - nonfiction
+  - thriller
+  - horror
+  - rom-com
+  - mystery
+  - self-help
+  - adaptation
+  - poetry
+  - revenge
+  - indie
+  - mythology
+  - dystopian
+  - sapphic romance
+  - adult fantasy
+  - childrens classic
+  - young adult
+  - middle grade
+  - science fiction
+  - historical fiction
+  - graphic novel
+item_type: ["story", "book", "cover", "novella"]
+first_last: ["first", "last"]
+author_type: ["new", "favorite", "asian", "black", "female", "LGBTQ+", "new to you"]
+title_word_count: ["one", "two", "three", "4+"]
+source: ["bookstagram", "booktube", "twitter", "goodreads"]
+setting: ["North America", "South America", "Europe", "Asia", "Africa", "Australia", "Sea"]
+trope: ["enemies to lovers", "animal sidekick", "friends to lovers", "marriage of convenience"]
+length: ["<300", "300-400", "400-500", "500-600", "600+"]
+year: <%= (["Before 2015"] << (2016..2021).to_a).flatten! %>
+on_the_cover: ["person", "animal", "weapon", "hand", "bird", "nature", "water"]
+representation: ["POC", "LGBTQ+", "Disability", "Asian", "Female", "Black"]
+topic: ["cooking", "travel", "music"]
+format: ["paperback", "hardcover", "audiobook", "ebook"]

data/lib/toberead.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative "toberead/decks"
+require_relative "toberead/properties"
+
+module ToBeRead
+  VERSION = "0.1.0"
+
+  class Error < StandardError; end
+
+  class << self
+    attr_reader :template_dir
+
+    def template_dir = File.join(__dir__, "toberead", "templates")
+  end
+end

data/toberead.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/toberead"
+
+Gem::Specification.new do |spec|
+  spec.name          = "toberead"
+  spec.version       = ToBeRead::VERSION
+  spec.authors       = ["ChronoSerrano"]
+  spec.email         = ["619512+ChronoSerrano@users.noreply.github.com"]
+
+  spec.summary       = "Write a short summary, because RubyGems requires one."
+  spec.description   = "Write a longer description or delete this line."
+  spec.homepage      = "https://github.com/chronoserrano/toberead"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 3.0.2"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://rubygems.org/toberead"
+  spec.metadata["changelog_uri"] = "https://github.com/chronoserrano/toberead/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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = ["tbr"]
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "titleize", "~> 1.4"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: toberead
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ChronoSerrano
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: titleize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: Write a longer description or delete this line.
+email:
+- 619512+ChronoSerrano@users.noreply.github.com
+executables:
+- tbr
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/tbr
+- lib/toberead.rb
+- lib/toberead/decks.rb
+- lib/toberead/properties.rb
+- lib/toberead/templates/answers.erb
+- lib/toberead/templates/prompts.erb
+- lib/toberead/templates/properties.yaml.erb
+- toberead.gemspec
+homepage: https://github.com/chronoserrano/toberead
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/chronoserrano/toberead
+  source_code_uri: https://rubygems.org/toberead
+  changelog_uri: https://github.com/chronoserrano/toberead/changelog.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Write a short summary, because RubyGems requires one.
+test_files: []