botany 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1b86a8a6151d29ac61e9efdd5fdb8afccbae6917679b41795e74cecf5b5faedf
+  data.tar.gz: bd7a9133a7cd83b033519b80d67104fec4850df3c1557db237658fa37494c4f1
+SHA512:
+  metadata.gz: 64d10aeef60321be5d7b15b5443e9ef51f4f88ab3987830258a5b6216513861a837e093cb7e0f563d7ea611827f2940bf819c821ae120f4b18e6275f7316333d
+  data.tar.gz: 2e5270d7a3a863ace2d6a2f41ef69c92ef82548afb5260f8b9647d245161666221ef505e5e2e0a7beabf7fa57ed77798676ccfabdf0b962800b17a516bf8c576

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,45 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.0
+
+Layout/LineLength:
+  Max: 120
+
+Lint/AmbiguousOperator:
+  Enabled: false
+
+RSpec/ExampleLength:
+  CountAsOne: ['array', 'hash']
+
+RSpec/ImplicitExpect:
+  EnforcedStyle: should
+
+RSpec/NoExpectationExample:
+  Enabled: false
+
+Style/DefWithParentheses:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: never
+
+Style/MethodDefParentheses:
+  EnforcedStyle: require_no_parentheses
+
+Style/MethodCallWithArgsParentheses:
+  EnforcedStyle: omit_parentheses
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: single_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-05-20
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 John DeSilva
+
+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,35 @@
+# Botany
+
+TODO: Delete this and the text below, and describe your gem
+
+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/botany`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## 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/Aesthetikx/botany.
+
+## 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,10 @@
+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/exe/botany

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'botany'
+
+exit Botany::CLI.run ARGV

data/lib/botany/bot.rb

@@ -0,0 +1,7 @@
+module Botany
+  class Bot
+    extend Botany::Enumerating
+    extend Botany::Scheduling
+    include Botany::Performing
+  end
+end

data/lib/botany/cli.rb

@@ -0,0 +1,33 @@
+require 'gli'
+
+module Botany
+  class CLI
+    extend GLI::App
+
+    version Botany::VERSION
+
+    program_desc 'Program description'
+
+    desc 'Update description'
+    command :update do |c|
+      c.action do |_global_options, _options, _arguments|
+        Botany::Scheduling.update_cron!
+      end
+    end
+
+    desc 'Run description'
+    command :run do |c|
+      c.action do |_global_options, _options, arguments|
+        task = arguments.first
+
+        klass_name, method = task.split '.'
+
+        method ||= 'perform'
+
+        bot = Object.const_get klass_name
+
+        bot.new.send method
+      end
+    end
+  end
+end

data/lib/botany/enumerating.rb

@@ -0,0 +1,19 @@
+module Botany
+  module Enumerating
+    prepend Enumerable
+
+    def all
+      klasses = ObjectSpace.each_object Class
+
+      klasses.select { |klass| klass < self }
+    end
+
+    def each &block
+      if block_given?
+        all.each &block
+      else
+        to_enum :each
+      end
+    end
+  end
+end

data/lib/botany/performing.rb

@@ -0,0 +1,7 @@
+module Botany
+  module Performing
+    def perform
+      raise Botany::Error, "#{self.class.name} should implement #perform"
+    end
+  end
+end

data/lib/botany/scheduling.rb

@@ -0,0 +1,58 @@
+require 'whenever'
+
+module Botany
+  module Scheduling
+    def schedule &block
+      if block_given?
+        instance_eval &block
+      else
+        schedule_entries
+      end
+    end
+
+    def whenever_configuration_entries
+      schedule_entries.map do |entry|
+        task = "#{name}.perform"
+
+        lambda do
+          every *entry do
+            run_bot task
+          end
+        end
+      end
+    end
+
+    def self.schedule_whenever! config
+      config.job_type :run_bot, 'cd :path && bundle exec botany run :task :output'
+
+      Botany::Bot.each do |bot|
+        bot.whenever_configuration_entries.each do |entry|
+          config.instance_exec &entry
+        end
+      end
+    end
+
+    def self.update_cron!
+      options = {
+        string: 'Botany::Scheduling.schedule_whenever! self',
+        update: true,
+        identifier: Bundler.root,
+        file: __FILE__ # We just need any file to prevent whenever from exiting
+      }
+
+      Signal.trap 'EXIT' do
+        Whenever::CommandLine.execute options
+      end
+    end
+
+    private
+
+    def every *args
+      schedule_entries << args
+    end
+
+    def schedule_entries
+      @schedule_entries ||= []
+    end
+  end
+end

data/lib/botany/version.rb

@@ -0,0 +1,3 @@
+module Botany
+  VERSION = '0.1.0'.freeze
+end

data/lib/botany.rb

@@ -0,0 +1,12 @@
+module Botany
+  class Error < StandardError; end
+end
+
+require_relative 'botany/enumerating'
+require_relative 'botany/performing'
+require_relative 'botany/scheduling'
+require_relative 'botany/version'
+
+require_relative 'botany/bot'
+
+require_relative 'botany/cli'

data/sig/botany.rbs

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

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: botany
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John DeSilva
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: whenever
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A framework for bots and scheduled tasks
+email:
+- john@aesthetikx.info
+executables:
+- botany
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/botany
+- lib/botany.rb
+- lib/botany/bot.rb
+- lib/botany/cli.rb
+- lib/botany/enumerating.rb
+- lib/botany/performing.rb
+- lib/botany/scheduling.rb
+- lib/botany/version.rb
+- sig/botany.rbs
+homepage: https://github.com/Aesthetikx/botany
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Aesthetikx/botany
+  source_code_uri: https://github.com/Aesthetikx/botany
+  changelog_uri: https://github.com/Aesthetikx/botany/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: A framework for bots and scheduled tasks
+test_files: []