ronin-code-asm 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ad5a87365920a6f38b31e9ea268d2c2b4e735a2e4386a3aa0579cd00c0fdf16
-  data.tar.gz: 7d56cd03b8001a61ef64d9feb30378e6c315ebf191d066b8565321257a288289
+  metadata.gz: 3c607b6198dafbb61854ad277ee380c3aab8eda4e137d572973e4f416993ff26
+  data.tar.gz: 3570c82008d63ad0ee4d43a06cc320168b194ed8fe98ab72b81590432215c0ad
 SHA512:
-  metadata.gz: 39999f88ef21563cb802fe25caf26cd31f32e78610c46f343ade50d081a399247f9a37d0d53466db58fcc99ea65f5e2a67b6c1cc5c6ae31f18c7416d64f55ef4
-  data.tar.gz: e744939e56cdc3f63129cf09bcdd3680cdb8dab885e368db8b71bda3a4e2fff56d21dd613d0d8bc1c1466793347733db08b4c9fa2f13d783ee6eceb40ed7f39d
+  metadata.gz: f6b7401d5e5368fd1caa46b9440b6904670fd036b8f905cba9030a00f75475fe4fa0b2cc2e901466de7db87290b7bd21c90b742370255a1c86da268cd2cb03ce
+  data.tar.gz: 8bdb550bab9838456e316ebf94dccc1b03081f6a3471fa5246265efed30cb759e3982d0d3495c6faa4e518d327f409d8e62ebbd74c3d97e0c2c92663e5ef9197

data/.github/workflows/ruby.yml

@@ -12,11 +12,13 @@ jobs:
           - '3.0'
           - '3.1'
           - '3.2'
-          # - jruby
+          - '3.3'
+          - '3.4'
+          - jruby
           - truffleruby
     name: Ruby ${{ matrix.ruby }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:

data/.ruby-version

@@ -1 +1 @@
-ruby-3.1
+ruby-3.3

data/ChangeLog.md

@@ -1,4 +1,9 @@
-### 1.0.0 / 2023-XX-XX
+### 1.0.1 / 2025-02-14
+
+* Use `require_relative` to improve load times.
+* Documentation improvements.
+
+### 1.0.0 / 2023-02-01
 
 * Require `ruby` >= 3.0.0.
 * Renamed the gem to `ronin-code-asm`.
@@ -17,7 +22,7 @@
 
       mov eax, 0x41
 
-* `Ronin::ASM::Program#byte`, `Ronin::ASM::Program#word`, 
+* `Ronin::ASM::Program#byte`, `Ronin::ASM::Program#word`,
   `Ronin::ASM::Program#dword` and `Ronin::ASM::Program#qword` methods can now
   accept `Ronin::ASM::MemoryOperand`s.
 

data/Gemfile

@@ -20,6 +20,6 @@ group :development do
   gem 'yard-spellcheck', require: false
 
   gem 'dead_end',        require: false
-  gem 'sord',            require: false
-  gem 'stackprof',       require: false
+  gem 'sord',            require: false, platform: :mri
+  gem 'stackprof',       require: false, platform: :mri
 end

data/README.md

@@ -8,7 +8,6 @@
 * [Issues](https://github.com/ronin-rb/ronin-code-asm/issues)
 * [Documentation](https://ronin-rb.dev/docs/ronin-code-asm/frames)
 * [Discord](https://discord.gg/6WAb3PsVX9) |
-  [Twitter](https://twitter.com/ronin_rb) |
   [Mastodon](https://infosec.exchange/@ronin_rb)
 
 ## Description
@@ -120,7 +119,7 @@ end
 
 ### Syscalls
 
-If the `:os` option is specified, then syscall numbers can be looked up via the 
+If the `:os` option is specified, then syscall numbers can be looked up via the
 `syscalls` Hash:
 
 ```ruby
@@ -139,15 +138,76 @@ end
 
 ## Install
 
+### Ubuntu
+
+```shell
+sudo apt install -y yasm
+gem install ronin-code-asm
+```
+
+### Fedora
+
+```shell
+sudo dnf install -y yasm
+gem install ronin-code-asm
+```
+
+### OpenSUSE
+
+```shell
+sudo zypper -n in -l yasm
+gem install ronin-code-asm
+```
+
+### Arch
+
 ```shell
-$ gem install ronin-code-asm
+sudo pacman -Sy yasm
+gem install ronin-code-asm
 ```
 
+### macOS
+
+```shell
+brew install yasm
+gem install ronin-code-asm
+```
+
+### FreeBSD
+
+```shell
+sudo pkg install -y yasm
+gem install ronin-code-asm
+```
+
+### Gemfile
+
+```ruby
+gem 'ronin-code-asm', '~> 1.0'
+```
+
+### gemspec
+
+```ruby
+gem.add_dependency 'ronin-code-asm', '~> 1.0'
+```
+
+## Development
+
+1. [Fork It!](https://github.com/ronin-rb/ronin-code-asm/fork)
+2. Clone It!
+3. `cd ronin-code-asm/`
+4. `bundle install`
+5. `git checkout -b my_feature`
+6. Code It!
+7. `bundle exec rake spec`
+8. `git push origin my_feature`
+
 ## License
 
 ronin-code-asm - A Ruby DSL for crafting Assembly programs and shellcode.
 
-Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+Copyright (c) 2007-2025 Hal Brodigan (postmodern.mod3 at gmail.com)
 
 ronin-code-asm is free software: you can redistribute it and/or modify
 it under the terms of the GNU Lesser General Public License as published
@@ -164,4 +224,4 @@ along with ronin-code-asm.  If not, see <https://www.gnu.org/licenses/>.
 
 [Ruby]: https://www.ruby-lang.org
 [yasm]: https://yasm.tortall.net/
-[ruby-yasm]: https://github.com/sophsec/ruby-yasm#readme
+[ruby-yasm]: https://github.com/postmodern/ruby-yasm#readme

data/gemspec.yml

@@ -3,7 +3,7 @@ summary: A Ruby DSL for crafting Assembly programs and Shellcode.
 description:
   ronin-code-asm is a Ruby DSL for crafting Assembly programs and shellcode.
 
-license: LGPL-3.0
+license: LGPL-3.0-or-later
 authors: Postmodern
 email: postmodern.mod3@gmail.com
 homepage: https://github.com/ronin-rb/ronin-code-asm#readme

data/lib/ronin/code/asm/archs/amd64.rb

@@ -2,7 +2,7 @@
 #
 # ronin-code-asm - A Ruby DSL for crafting Assembly programs and shellcode.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2025 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-code-asm is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -18,7 +18,7 @@
 # along with ronin-code-asm.  If not, see <https://www.gnu.org/licenses/>.
 #
 
-require 'ronin/code/asm/archs/x86'
+require_relative 'x86'
 
 module Ronin
   module Code

data/lib/ronin/code/asm/archs/x86.rb

@@ -2,7 +2,7 @@
 #
 # ronin-code-asm - A Ruby DSL for crafting Assembly programs and shellcode.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2025 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-code-asm is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -18,7 +18,7 @@
 # along with ronin-code-asm.  If not, see <https://www.gnu.org/licenses/>.
 #
 
-require 'ronin/code/asm/register'
+require_relative '../register'
 
 module Ronin
   module Code
@@ -133,7 +133,7 @@ module Ronin
 
           #
           # Generates the instruction to set a register.
-          # 
+          #
           # @param [Symbol] name
           #   The name of the register.
           #
@@ -146,7 +146,7 @@ module Ronin
 
           #
           # Generates the instruction to save a register.
-          # 
+          #
           # @param [Symbol] name
           #   The name of the register.
           #
@@ -156,7 +156,7 @@ module Ronin
 
           #
           # Generates the instruction to restore a register.
-          # 
+          #
           # @param [Symbol] name
           #   The name of the register.
           #

data/lib/ronin/code/asm/archs.rb

@@ -2,7 +2,7 @@
 #
 # ronin-code-asm - A Ruby DSL for crafting Assembly programs and shellcode.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2025 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-code-asm is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -18,5 +18,5 @@
 # along with ronin-code-asm.  If not, see <https://www.gnu.org/licenses/>.
 #
 
-require 'ronin/code/asm/archs/x86'
-require 'ronin/code/asm/archs/amd64'
+require_relative 'archs/x86'
+require_relative 'archs/amd64'

data/lib/ronin/code/asm/config.rb

@@ -2,7 +2,7 @@
 #
 # ronin-code-asm - A Ruby DSL for crafting Assembly programs and shellcode.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2025 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-code-asm is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/code/asm/immediate_operand.rb

@@ -2,7 +2,7 @@
 #
 # ronin-code-asm - A Ruby DSL for crafting Assembly programs and shellcode.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2025 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-code-asm is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/code/asm/instruction.rb

@@ -2,7 +2,7 @@
 #
 # ronin-code-asm - A Ruby DSL for crafting Assembly programs and shellcode.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2025 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-code-asm is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -18,7 +18,7 @@
 # along with ronin-code-asm.  If not, see <https://www.gnu.org/licenses/>.
 #
 
-require 'ronin/code/asm/immediate_operand'
+require_relative 'immediate_operand'
 
 module Ronin
   module Code

data/lib/ronin/code/asm/memory_operand.rb

@@ -2,7 +2,7 @@
 #
 # ronin-code-asm - A Ruby DSL for crafting Assembly programs and shellcode.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2025 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-code-asm is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -18,7 +18,7 @@
 # along with ronin-code-asm.  If not, see <https://www.gnu.org/licenses/>.
 #
 
-require 'ronin/code/asm/register'
+require_relative 'register'
 
 module Ronin
   module Code

data/lib/ronin/code/asm/os/freebsd.rb

@@ -2,7 +2,7 @@
 #
 # ronin-code-asm - A Ruby DSL for crafting Assembly programs and shellcode.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2025 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-code-asm is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -18,7 +18,7 @@
 # along with ronin-code-asm.  If not, see <https://www.gnu.org/licenses/>.
 #
 
-require 'ronin/code/asm/config'
+require_relative '../config'
 
 module Ronin
   module Code

data/lib/ronin/code/asm/os/linux.rb

@@ -2,7 +2,7 @@
 #
 # ronin-code-asm - A Ruby DSL for crafting Assembly programs and shellcode.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2025 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-code-asm is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -18,7 +18,7 @@
 # along with ronin-code-asm.  If not, see <https://www.gnu.org/licenses/>.
 #
 
-require 'ronin/code/asm/config'
+require_relative '../config'
 
 module Ronin
   module Code

data/lib/ronin/code/asm/os/os.rb

@@ -2,7 +2,7 @@
 #
 # ronin-code-asm - A Ruby DSL for crafting Assembly programs and shellcode.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2025 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-code-asm is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -18,7 +18,7 @@
 # along with ronin-code-asm.  If not, see <https://www.gnu.org/licenses/>.
 #
 
-require 'ronin/code/asm/config'
+require_relative '../config'
 
 require 'yaml'
 

data/lib/ronin/code/asm/os.rb

@@ -2,7 +2,7 @@
 #
 # ronin-code-asm - A Ruby DSL for crafting Assembly programs and shellcode.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2025 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-code-asm is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -18,9 +18,9 @@
 # along with ronin-code-asm.  If not, see <https://www.gnu.org/licenses/>.
 #
 
-require 'ronin/code/asm/os/os'
-require 'ronin/code/asm/os/freebsd'
-require 'ronin/code/asm/os/linux'
+require_relative 'os/os'
+require_relative 'os/freebsd'
+require_relative 'os/linux'
 
 module Ronin
   module Code

data/lib/ronin/code/asm/program.rb

@@ -2,7 +2,7 @@
 #
 # ronin-code-asm - A Ruby DSL for crafting Assembly programs and shellcode.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2025 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-code-asm is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -18,12 +18,12 @@
 # along with ronin-code-asm.  If not, see <https://www.gnu.org/licenses/>.
 #
 
-require 'ronin/code/asm/archs'
-require 'ronin/code/asm/os'
-require 'ronin/code/asm/register'
-require 'ronin/code/asm/instruction'
-require 'ronin/code/asm/immediate_operand'
-require 'ronin/code/asm/syntax'
+require_relative 'archs'
+require_relative 'os'
+require_relative 'register'
+require_relative 'instruction'
+require_relative 'immediate_operand'
+require_relative 'syntax'
 
 require 'tempfile'
 require 'yasm/program'
@@ -198,7 +198,7 @@ module Ronin
         #
         # Creates an operand of size 1 (byte).
         #
-        # @param [MemoryOperand, Integer] op 
+        # @param [MemoryOperand, Integer] op
         #   The value of the operand.
         #
         # @return [MemoryOperand, ImmediateOperand]

data/lib/ronin/code/asm/register.rb

@@ -2,7 +2,7 @@
 #
 # ronin-code-asm - A Ruby DSL for crafting Assembly programs and shellcode.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2025 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-code-asm is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -18,7 +18,7 @@
 # along with ronin-code-asm.  If not, see <https://www.gnu.org/licenses/>.
 #
 
-require 'ronin/code/asm/memory_operand'
+require_relative 'memory_operand'
 
 module Ronin
   module Code

data/lib/ronin/code/asm/shellcode.rb

@@ -2,7 +2,7 @@
 #
 # ronin-code-asm - A Ruby DSL for crafting Assembly programs and shellcode.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2025 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-code-asm is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/code/asm/syntax/att.rb

@@ -2,7 +2,7 @@
 #
 # ronin-code-asm - A Ruby DSL for crafting Assembly programs and shellcode.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2025 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-code-asm is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/code/asm/syntax/common.rb

@@ -2,7 +2,7 @@
 #
 # ronin-code-asm - A Ruby DSL for crafting Assembly programs and shellcode.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2025 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-code-asm is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/code/asm/syntax/intel.rb

@@ -2,7 +2,7 @@
 #
 # ronin-code-asm - A Ruby DSL for crafting Assembly programs and shellcode.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2025 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-code-asm is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/code/asm/syntax.rb

@@ -2,7 +2,7 @@
 #
 # ronin-code-asm - A Ruby DSL for crafting Assembly programs and shellcode.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2025 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-code-asm is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/code/asm/version.rb

@@ -2,7 +2,7 @@
 #
 # ronin-code-asm - A Ruby DSL for crafting Assembly programs and shellcode.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2025 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-code-asm is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -22,7 +22,7 @@ module Ronin
   module Code
     module ASM
       # ronin-code-asm version
-      VERSION = '1.0.0'
+      VERSION = '1.0.1'
     end
   end
 end

data/lib/ronin/code/asm.rb

@@ -2,7 +2,7 @@
 #
 # ronin-code-asm - A Ruby DSL for crafting Assembly programs and shellcode.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2025 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-code-asm is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -18,9 +18,9 @@
 # along with ronin-code-asm.  If not, see <https://www.gnu.org/licenses/>.
 #
 
-require 'ronin/code/asm/program'
-require 'ronin/code/asm/shellcode'
-require 'ronin/code/asm/version'
+require_relative 'asm/program'
+require_relative 'asm/shellcode'
+require_relative 'asm/version'
 
 module Ronin
   module Code

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ronin-code-asm
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-01 00:00:00.000000000 Z
+date: 2025-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-yasm
@@ -88,7 +88,7 @@ files:
 - ronin-code-asm.gemspec
 homepage: https://github.com/ronin-rb/ronin-code-asm#readme
 licenses:
-- LGPL-3.0
+- LGPL-3.0-or-later
 metadata:
   documentation_uri: https://ronin-rb.dev/docs/ronin-code-asm
   source_code_uri: https://github.com/ronin-rb/ronin-code-asm
@@ -111,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - yasm >= 0.6.0
-rubygems_version: 3.3.26
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: A Ruby DSL for crafting Assembly programs and Shellcode.