pokepaste 0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6d17c57c81b0801cd9628e74eb0a1632fbf0be50fa2a2cec58b3b0bdd10492e4
+  data.tar.gz: d6b16c078757ff881a8e87341330f10e8c7ac94c36aac2da960ae53db32882fb
+SHA512:
+  metadata.gz: 142c409f1da71ff043710f94f48a03953fdf26682079a7abc54e3f9a6395e1d43b2164156b6c556f8627904e837ebea114304407af8f78d279b68aecf033fd51
+  data.tar.gz: b5bd9cb65f42d138aec7b22d8bb496ce8b4980cdda65ae5cff2963357109680a7e156da3040588545aba1e43df723129dc3f48385dbae1ebd08a266b12fe558f

data/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright © 2023 Vinny Diehl
+
+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,108 @@
+# PokéPaste Ruby
+
+Ruby parser for [PokéPaste](https://pokepast.es/syntax.html), the format used
+by Pokémon Showdown and various teambuilders.
+
+## Installation
+
+Install with RubyGems:
+
+```bash
+gem install pokepaste
+```
+
+If using in your application, include in your `Gemfile`:
+
+```ruby
+gem "pokepaste"
+```
+
+or your `.gemspec`:
+
+```ruby
+Gem::Specification.new do |gem|
+  # ...
+
+  gem.add_runtime_dependency "pokepaste"
+end
+```
+
+## Usage
+
+To parse a PokéPaste:
+
+```ruby
+# From a string
+team = PokePaste::parse(str)
+
+# From pokepast.es
+team = PokePaste::fetch("https://pokepast.es/5c46f9ec443664cb")
+team = PokePaste::fetch("5c46f9ec443664cb") # full URL optional
+```
+
+Once you have it parsed, you have an instance of `PokePaste::Team`, an
+Enumerable containing an instance of `PokePaste::Pokemon` for each Pokémon on
+the team. You can loop over the team as with any Enumerable, and access the
+data like so:
+
+```ruby
+team.each do |pkmn|
+  pkmn.species # required
+  pkmn.nickname # default null
+  pkmn.gender # default null
+  pkmn.item # default null
+
+  # EVs and IVs are hashes with the stat as the key
+  # (:hp, :atk, :def, :spa, :spd, or :spe)
+  pkmn.evs[:hp] # default 0
+  pkmn.ivs[:spa] # default 31
+
+  pkmn.shiny? # default is false
+  pkmn.ability # default is null
+  pkmn.level # default is 50
+  pkmn.happiness # default is 255
+  pkmn.nature # default is :hardy (neutral nature)
+
+  # Moves are an array with the names of the moves as strings. If more than
+  # one move is specified for a slot, they will be put into an array
+  pkmn.moves # default is []
+end
+```
+
+You can edit any of these properties, and process back into PokéPaste format
+with `#to_s`:
+
+```ruby
+paste = team.to_s
+single_pokemon = team[3].to_s
+```
+
+To make a new paste, you can initialize a new `PokePaste::Team` and populate
+it like so:
+
+```ruby
+team = PokePaste::Team.new
+
+team << PokePaste::Pokemon.new(
+  species: "Bulbasaur",
+  nickname: "Bud",
+  ivs: {atk: 0},
+  moves: %w[Tackle Growl]
+)
+
+puts team # prints the paste
+```
+
+And I suppose if you wanted to use this library just to fetch the raw text from
+a paste on [pokepast.es](https://pokepast.es/), you could:
+
+```ruby
+raw_paste = PokePaste.fetch(url_or_id).to_s
+```
+
+## License
+
+This library is released under the MIT license. See the
+[`LICENSE.md`](https://github.com/vinnydiehl/pokepaste-ruby/blob/master/LICENSE.md)
+file included with this code or
+[the official page on OSI](http://opensource.org/licenses/MIT) for more information.

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new :spec
+task test: :spec
+
+require "yard"
+YARD::Rake::YardocTask.new do |doc|
+  doc.files << "lib/**/*.rb"
+  doc.options << ["--title", "PokéPaste Ruby #{File.read 'VERSION'} Documentation"]
+end
+task doc: :yard
+
+task dist: :build
+task default: :spec

data/VERSION

@@ -0,0 +1 @@
+0.0

data/lib/pokepaste/paste.rb

@@ -0,0 +1,18 @@
+module PokePaste
+  class Team
+    include Enumerable
+    extend Forwardable
+    def_delegators :@team, *%i[size length [] empty? last index]
+
+    def initialize(paste)
+      @team = []
+    end
+
+    def each(&block)
+      @team.each &block
+    end
+
+    def to_s
+    end
+  end
+end

data/lib/pokepaste/pokemon.rb

@@ -0,0 +1,9 @@
+module PokePaste
+  class Pokemon
+    def initialize
+    end
+
+    def to_s
+    end
+  end
+end

data/lib/pokepaste.rb

@@ -0,0 +1,10 @@
+require "pokepaste/paste"
+require "pokepaste/pokemon"
+
+module PokePaste
+  def parse(paste)
+  end
+
+  def fetch(str)
+  end
+end

data/pokepaste.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |gem|
+  gem.name = "pokepaste"
+  gem.version = File.read "VERSION"
+
+  gem.author = "Vinny Diehl"
+  gem.email = "vinny.diehl@gmail.com"
+  gem.homepage = "https://github.com/vinnydiehl/pokepaste-ruby"
+
+  gem.license = "MIT"
+
+  gem.summary = "PokéPaste parser for Ruby"
+  gem.description = "Parses PokéPastes into an object that you can easily read/manipulate/save."
+
+  gem.require_paths = %w[lib]
+  gem.test_files = Dir["spec/**/*"]
+  gem.files = Dir["lib/**/*"] + gem.test_files + %w[
+    VERSION Rakefile README.md LICENSE.md pokepaste.gemspec
+  ]
+
+  gem.required_ruby_version = ">= 2.0"
+  gem.add_development_dependency "rake", "~> 13.0"
+  gem.add_development_dependency "rspec", "~> 3.12"
+  gem.add_development_dependency "fuubar", "~> 2.5"
+  gem.add_development_dependency "yard", "~> 0.9"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+# Include all files in spec/support
+Dir[File.expand_path("../support/**/*.rb", __FILE__)].each { |f| require f }
+
+RSpec.configure do |config|
+  # Fuubar
+  config.add_formatter "Fuubar"
+  config.fuubar_progress_bar_options = { format: "  %c/%C |%b>%i|%e " }
+
+  # More verbose output if only running one spec
+  config.default_formatter = "doc" if config.files_to_run.one?
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, fix the order by providing the seed,
+  # which is printed after each run, e.g. --seed 1234
+  config.order = :random
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: pokepaste
+version: !ruby/object:Gem::Version
+  version: '0.0'
+platform: ruby
+authors:
+- Vinny Diehl
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Parses PokéPastes into an object that you can easily read/manipulate/save.
+email: vinny.diehl@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- Rakefile
+- VERSION
+- lib/pokepaste.rb
+- lib/pokepaste/paste.rb
+- lib/pokepaste/pokemon.rb
+- pokepaste.gemspec
+- spec/spec_helper.rb
+homepage: https://github.com/vinnydiehl/pokepaste-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: PokéPaste parser for Ruby
+test_files:
+- spec/spec_helper.rb