ruby-yasm 0.1.0 → 0.3.0

data/lib/yasm/program.rb

@@ -1,52 +1,47 @@
-require 'yasm/task'
-
-require 'rprogram'
-require 'tempfile'
+require 'yasm/command'
 
 module YASM
-  class Program < RProgram::Program
-
-    name_program 'yasm'
+  #
+  # @deprecated Please use {Command} instead.
+  #
+  class Program < Command
 
     #
-    # Finds the +yasm+ program and assembles a file.
+    # Finds the `yasm` program and assembles a file.
     #
     # @param [Hash{Symbol => Object}] options
     #   Additional options for yasm.
     #
-    # @yield [task]
-    #   If a block is given, it will be passed a task object used to
+    # @yield [program]
+    #   If a block is given, it will be passed a program object used to
     #   specify options for yasm.
     #
-    # @yieldparam [Task] task
-    #   The yasm task object.
+    # @yieldparam [Program] program
+    #   The yasm program object.
     #
     # @return [Boolean]
     #   Specifies whether the command exited normally.
     #
-    def self.assmeble(options={},&block)
-      self.find().assemble(options,&block)
-    end
-
+    # @example
+    #   Program.assemble(
+    #     :parser => :gas,
+    #     :output => 'code.o',
+    #     :file   => 'code.S'
+    #   )
     #
-    # Finds the +yasm+ program, then assembles an assembly file and writes
-    # the output to a temporary file.
+    # @example
+    #   Program.assemble do |yasm|
+    #     yasm.target! :x86
     #
-    # @param [Hash{Symbol => Object}] options
-    #   Additional options for yasm.
+    #     yasm.syntax = :gas
+    #     yasm.file   = 'code.S'
+    #     yasm.output = 'code.o'
+    #   end
     #
-    # @yield [task]
-    #   If a block is given, it will be passed a task object used to
-    #   specify options for yasm.
-    #
-    # @yieldparam [Task] task
-    #   The yasm task object.
-    #
-    # @return [TempFile]
-    #   The temporary file containing the assembled object code.
+    # @see #assemble
     #
-    def self.assemble_temp(options={},&block)
-      self.find().assemble(options,&block)
+    def self.assemble(options={},&block)
+      new(options,&block).assemble()
     end
 
     #
@@ -55,43 +50,48 @@ module YASM
     # @param [Hash{Symbol => Object}] options
     #   Additional options for yasm.
     #
-    # @yield [task]
-    #   If a block is given, it will be passed a task object used to
+    # @yield [program]
+    #   If a block is given, it will be passed a program object used to
     #   specify options for yasm.
     #
-    # @yieldparam [Task] task
-    #   The yasm task object.
+    # @yieldparam [Program] program
+    #   The yasm program object.
     #
     # @return [Boolean]
     #   Specifies whether the command exited normally.
     #
-    def assemble(options={},&block)
-      run_task(Task.new(options,&block))
+    # @example
+    #   Program.assemble(
+    #     :parser => :gas,
+    #     :output => 'code.o',
+    #     :file   => 'code.S'
+    #   )
+    #
+    # @example
+    #   Program.assemble do |yasm|
+    #     yasm.target! :x86
+    #
+    #     yasm.syntax = :gas
+    #     yasm.file   = 'code.S'
+    #     yasm.output = 'code.o'
+    #   end
+    #
+    def assemble(options={})
+      options.each do |name,value|
+        self[name] = value
+      end
+
+      yield self if block_given?
+
+      run_command()
     end
 
     #
-    # Assembles an assembly file and writes the output to a temporary file.
-    #
-    # @param [Hash{Symbol => Object}] options
-    #   Additional options for yasm.
-    #
-    # @yield [task]
-    #   If a block is given, it will be passed a task object used to
-    #   specify options for yasm.
-    #
-    # @yieldparam [Task] task
-    #   The yasm task object.
-    #
-    # @return [TempFile]
-    #   The temporary file containing the assembled object code.
+    # @deprecated Please use {#target=} instead.
     #
-    def assemble_temp(options={},&block)
-      task = Task.new(options,&block)
-      task.output = Tempfile.new('yasm').path
-
-      if run_task(task)
-        return task.output
-      end
+    def target!(name)
+      self.target = name
+      return true
     end
 
   end

data/lib/yasm/version.rb

@@ -1,4 +1,4 @@
 module YASM
   # ruby-yasm VERSION
-  VERSION = '0.1.0'
+  VERSION = '0.3.0'
 end

data/lib/yasm.rb

@@ -1,2 +1,3 @@
+require 'yasm/command'
 require 'yasm/program'
 require 'yasm/version'

data/ruby-yasm.gemspec

@@ -0,0 +1,58 @@
+require 'yaml'
+
+Gem::Specification.new do |gem|
+  gemspec = YAML.load_file('gemspec.yml')
+
+  gem.name    = gemspec.fetch('name')
+  gem.version = gemspec.fetch('version') do
+                  lib_dir = File.join(File.dirname(__FILE__),'lib')
+                  $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+
+                  require 'yasm/version'
+                  YASM::VERSION
+                end
+
+  gem.summary     = gemspec['summary']
+  gem.description = gemspec['description']
+  gem.licenses    = Array(gemspec['license'])
+  gem.authors     = Array(gemspec['authors'])
+  gem.email       = gemspec['email']
+  gem.homepage    = gemspec['homepage']
+  gem.metadata    = gemspec['metadata'] if gemspec['metadata']
+
+  glob = lambda { |patterns| gem.files & Dir[*patterns] }
+
+  gem.files = if gemspec['files'] then glob[gemspec['files']]
+              else                     `git ls-files`.split($/)
+              end
+
+  gem.executables = gemspec.fetch('executables') do
+    glob['bin/*'].map { |path| File.basename(path) }
+  end
+
+  gem.extensions       = glob[gemspec['extensions'] || 'ext/**/extconf.rb']
+  gem.extra_rdoc_files = glob[gemspec['extra_doc_files'] || '*.{txt,md}']
+
+  gem.require_paths = Array(gemspec.fetch('require_paths') {
+    %w[ext lib].select { |dir| File.directory?(dir) }
+  })
+
+  gem.requirements              = gemspec['requirements']
+  gem.required_ruby_version     = gemspec['required_ruby_version']
+  gem.required_rubygems_version = gemspec['required_rubygems_version']
+  gem.post_install_message      = gemspec['post_install_message']
+
+  split = lambda { |string| string.split(/,\s*/) }
+
+  if gemspec['dependencies']
+    gemspec['dependencies'].each do |name,versions|
+      gem.add_dependency(name,split[versions])
+    end
+  end
+
+  if gemspec['development_dependencies']
+    gemspec['development_dependencies'].each do |name,versions|
+      gem.add_development_dependency(name,split[versions])
+    end
+  end
+end

data/spec/command_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+require 'helpers/files'
+
+require 'yasm/command'
+require 'tempfile'
+
+describe YASM::Command do
+  include Helpers::Files
+
+  describe ".run" do
+    subject { described_class }
+
+    it "should be able to assemble a file" do
+      file = Tempfile.new('yasm').path
+
+      subject.run do |yasm|
+        yasm.target = :x86
+        yasm.syntax = :gas
+        yasm.file = assembly_file('gas')
+        yasm.output = file
+      end
+
+      expect(File.size(file)).to be > 0
+    end
+  end
+
+  describe "#target" do
+    context "when no target has been set" do
+      it "must return nil" do
+        expect(subject.target).to be(nil)
+      end
+    end
+
+    context "when the target has been set to :x86" do
+      before { subject.target = :x86 }
+
+      it "must return :x86" do
+        expect(subject.target).to eq(:x86)
+      end
+    end
+
+    context "when #arch is :x86 and #machine is :x86" do
+      before do
+        subject.arch    = :x86
+        subject.machine = :x86
+      end
+
+      it "must return :x86" do
+        expect(subject.target).to eq(:x86)
+      end
+    end
+
+    context "when the target has been set to :amd64" do
+      before { subject.target = :amd64}
+
+      it "must return :amd64" do
+        expect(subject.target).to eq(:amd64)
+      end
+    end
+
+    context "when #arch is :x86 and #machine is :amd64" do
+      before do
+        subject.arch    = :x86
+        subject.machine = :amd64
+      end
+
+      it "must return :amd64" do
+        expect(subject.target).to eq(:amd64)
+      end
+    end
+
+    context "when the target has been set to :lc3b" do
+      before { subject.target = :lc3b}
+
+      it "must return :lc3b" do
+        expect(subject.target).to eq(:lc3b)
+      end
+    end
+
+    context "when #arch is :lc3b and #machine is :lc3b" do
+      before do
+        subject.arch    = :lc3b
+        subject.machine = :lc3b
+      end
+
+      it "must return :lc3b" do
+        expect(subject.target).to eq(:lc3b)
+      end
+    end
+  end
+end

data/spec/program_spec.rb

@@ -1,38 +1,104 @@
-require 'yasm/program'
-
 require 'spec_helper'
 require 'helpers/files'
 
-describe Program do
+require 'yasm/program'
+require 'tempfile'
+
+describe YASM::Program do
   include Helpers::Files
 
-  before(:all) do
-    @yasm = Program.find
+  describe ".assemble" do
+    subject { described_class }
+
+    it "should be able to assemble a file" do
+      file = Tempfile.new('yasm').path
+
+      subject.assemble do |yasm|
+        yasm.target! :x86
+
+        yasm.syntax = :gas
+        yasm.file = assembly_file('gas')
+        yasm.output = file
+      end
+
+      expect(File.size(file)).to be > 0
+    end
   end
 
-  it "should be able to assemble a file" do
-    file = Tempfile.new('yasm').path
+  describe "#assemble" do
+    it "should be able to assemble a file" do
+      file = Tempfile.new('yasm').path
+
+      subject.assemble do |yasm|
+        yasm.target! :x86
 
-    @yasm.assemble do |yasm|
-      yasm.target! :x86
+        yasm.syntax = :gas
+        yasm.file = assembly_file('gas')
+        yasm.output = file
+      end
 
-      yasm.syntax = :gas
-      yasm.file = assembly_file('gas')
-      yasm.output = file
+      expect(File.size(file)).to be > 0
     end
+  end
+
+  describe "#initialize" do
+    subject { described_class.new(target: :amd64) }
 
-    File.size(file).should > 0
+    it "should support a :target option" do
+      expect(subject.arch).to eq(:x86)
+      expect(subject.machine).to eq(:amd64)
+    end
   end
 
-  it "should assemble a file, and write the output to a temporary file" do
-    file = @yasm.assemble_temp do |yasm|
-      yasm.target! :x86
+  describe "#target!" do
+    it "should return true for valid targets" do
+      expect(subject.target!(:amd64)).to be(true)
+    end
+
+    context "when given an unknown target name" do
+      let(:name) { :lol }
 
-      yasm.syntax = :gas
-      yasm.file = assembly_file('gas')
+      it "should raise ArgumentError when passed unknown targets" do
+        expect {
+          subject.target!(name)
+        }.to raise_error(ArgumentError,"unknown YASM target: #{name.inspect}")
+      end
     end
 
-    file.should_not be_nil
-    File.size(file).should > 0
+    context "when given :x86" do
+      before { subject.target!(:x86) }
+
+      it "should set the #arch value" do
+        expect(subject.arch).to eq(:x86)
+      end
+
+      it "should set the #machine value" do
+        expect(subject.machine).to eq(:x86)
+      end
+    end
+
+    context "when given :amd64" do
+      before { subject.target!(:amd64) }
+
+      it "should set the #arch value" do
+        expect(subject.arch).to eq(:x86)
+      end
+
+      it "should set the #machine value" do
+        expect(subject.machine).to eq(:amd64)
+      end
+    end
+
+    context "when given :lc3b" do
+      before { subject.target!(:lc3b) }
+
+      it "should set the #arch value" do
+        expect(subject.arch).to eq(:lc3b)
+      end
+
+      it "should set the #machine value" do
+        expect(subject.machine).to eq(:lc3b)
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,7 +1,6 @@
-require 'rubygems'
-gem 'rspec', '>=1.2.9'
-require 'spec'
+require 'rspec'
+require 'simplecov'
+SimpleCov.start
 
 require 'yasm/version'
-
 include YASM

data/spec/yasm_spec.rb

@@ -4,6 +4,6 @@ require 'spec_helper'
 
 describe YASM do
   it "should have a VERSION constant" do
-    YASM.const_defined?('VERSION').should == true
+    expect(subject.const_defined?('VERSION')).to eq(true)
   end
 end

metadata

@@ -1,140 +1,98 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ruby-yasm
-version: !ruby/object:Gem::Version 
-  version: 0.1.0
+version: !ruby/object:Gem::Version
+  version: 0.3.0
 platform: ruby
-authors: 
+authors:
 - Postmodern
-autorequire: 
+autorequire:
 bindir: bin
-cert_chain: 
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDQDCCAiigAwIBAgIBADANBgkqhkiG9w0BAQUFADBGMRgwFgYDVQQDDA9wb3N0
-  bW9kZXJuLm1vZDMxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixk
-  ARkWA2NvbTAeFw0wOTA2MDMwNDU5MDNaFw0xMDA2MDMwNDU5MDNaMEYxGDAWBgNV
-  BAMMD3Bvc3Rtb2Rlcm4ubW9kMzEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYK
-  CZImiZPyLGQBGRYDY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA
-  1wvANkTDHFgVih5XLjuTwTZjgBq1lBGybXJiH6Id1lY2JOMqM5FB1DDHVvvij94i
-  mJabN0zkzu6VKWC70y0IwOxY7CPokr0eFdK/D0y7mCq1P8QITv76i2YqAl0eYqIt
-  W+IhIkANQ7E6uMZIZcdnfadC6lPAtlKkqtd9crvRbFgr6e3kyflmohbRnTEJHoRd
-  7SHHsybE6DSn7oTDs6XBTNrNIn5VfZA0z01eeos/+zBm1zKJOK2+/7xtLLDuDU9G
-  +Rd+ltUBbvxUrMNZmDG29pnmN2xTRH+Q8HxD2AxlvM5SRpK6OeZaHV7PaCCAVZ4L
-  T9BFl1sfMvRlABeGEkSyuQIDAQABozkwNzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIE
-  sDAdBgNVHQ4EFgQUKwsd+PqEYmBvyaTyoL+uRuk+PhEwDQYJKoZIhvcNAQEFBQAD
-  ggEBAB4TvHsrlbcXcKg6gX5BIb9tI+zGkpzo0Z7jnxMEcNO7NGGwmzafDBI/xZYv
-  xkRH3/HXbGGYDOi6Q6gWt5GujSx0bOImDtYTJTH8jnzN92HzEK5WdScm1QpZKF1e
-  cezArMbxbSPaosxTCtG6LQTkE28lFQsmFZ5xzouugS4h5+LVJiVMmiP+l3EfkjFa
-  GOURU+rNEMPWo8MCWivGW7jes6BMzWHcW7DQ0scNVmIcCIgdyMmpscuAEOSeghy9
-  /fFs57Ey2OXBL55nDOyvN/ZQ2Vab05UH4t+GCxjAPeirzL/29FBtePT6VD44c38j
-  pDj+ws7QjtH/Qcrr1l9jfN0ehDs=
-  -----END CERTIFICATE-----
-
-date: 2009-12-27 00:00:00 -08:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rprogram
+cert_chain: []
+date: 2022-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: command_mapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.1.8
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: rspec
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.2.9
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: yard
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.5.2
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 2.4.0
-    version: 
-description: |-
-  A Ruby interface to YASM.
-  
-  YASM is a complete rewrite of the NASM assembler, YASM currently supports
-  the x86 and AMD64 instruction sets, accepts NASM and GAS assembler syntaxes,
-  outputs binary, ELF32, ELF64, 32 and 64-bit Mach-O, RDOFF2, COFF, Win32,
-  and Win64 object formats, and generates source debugging information in
-  STABS, DWARF 2, and CodeView 8 formats.
-email: 
-- postmodern.mod3@gmail.com
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: ruby-yasm provides a Ruby interface to YASM assembler.
+email: postmodern.mod3@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- Manifest.txt
-files: 
-- History.rdoc
-- Manifest.txt
-- README.rdoc
+extra_rdoc_files:
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- ".gemtest"
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".specopts"
+- ".yardopts"
+- ChangeLog.md
+- Gemfile
+- LICENSE.txt
+- README.md
 - Rakefile
+- gemspec.yml
 - lib/yasm.rb
-- lib/yasm/task.rb
+- lib/yasm/command.rb
 - lib/yasm/program.rb
-- lib/yasm/yasm.rb
 - lib/yasm/version.rb
-- tasks/spec.rb
-- tasks/yard.rb
-- spec/spec_helper.rb
+- ruby-yasm.gemspec
+- spec/command_spec.rb
 - spec/helpers/files.rb
 - spec/helpers/files/gas.S
-- spec/task_spec.rb
 - spec/program_spec.rb
+- spec/spec_helper.rb
 - spec/yasm_spec.rb
-has_rdoc: yard
-homepage: http://www.tortall.net/projects/yasm/
-licenses: []
-
-post_install_message: 
-rdoc_options: 
-- --main
-- README.rdoc
-require_paths: 
+homepage: https://github.com/postmodern/ruby-yasm#readme
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-requirements: []
-
-rubyforge_project: ruby-yasm
-rubygems_version: 1.3.5
-signing_key: 
-specification_version: 3
-summary: A Ruby interface to YASM
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- yasm >= 0.6.0
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: A Ruby interface to YASM.
 test_files: []
-

data/History.rdoc

@@ -1,4 +0,0 @@
-=== 0.1.0 / 2009-12-24
-
-* Initial release.
-