gcodify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d6ca366e559cf2c657555bcdb1fa9b175258125b53465218e423449038c0d8fe
+  data.tar.gz: c0356174afd8e3579aae164ba10d12fb8039076d60cf5ff647033204df0e1105
+SHA512:
+  metadata.gz: ddd5dd245bc4c67408c7747bd93c78f64ab70ba55e42cbc6e38257ead4c546adf553c32c35ae6b03b3378b4ab88426737d7cb0ea79abe3469d5d2c141479616d
+  data.tar.gz: a88a9aa5a559b2d6cee563648be8bd7d8571e50d5aee8e9962dbf0708e54f1fbdaa649fff3d19e49278a454355ef8b832ee0e12b1f1bf43858feccba7f53e60a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+sudo: false
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.4
+script: rake spec

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gcodify.gemspec
+gemspec
+
+gem 'coveralls', require: false
+gem 'pry'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Liam Marshall
+
+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,60 @@
+# Gcodify
+
+[![Build Status](https://travis-ci.org/ArchimedesPi/gcodify.svg?branch=master)](https://travis-ci.org/ArchimedesPi/gcodify) [![Inline docs](http://inch-ci.org/github/ArchimedesPi/gcodify.svg?branch=master)](http://inch-ci.org/github/ArchimedesPi/gcodify) [![Code Climate](https://codeclimate.com/github/ArchimedesPi/gcodify/badges/gpa.svg)](https://codeclimate.com/github/ArchimedesPi/gcodify) [![Coverage Status](https://coveralls.io/repos/ArchimedesPi/gcodify/badge.svg?branch=master)](https://coveralls.io/r/ArchimedesPi/gcodify?branch=master)
+
+Gcodify is a Ruby DSL for more easily hand-writing gcode. When it comes time to make something in the physical world on a mill or lathe, if you don't have a CAD model, then you're going to have to manually write gcode, which is **NOT FUN**. Even if you do, CAM software is a pain to use, and may be harder to configure than hand-writing gcode. Gcodify makes handwriting gcode fun - forget the look-up of obscure gcode features and just write the things you want made, like cuts, holes, and pockets. Like CAM, but handwritten!
+
+## Feature status list
+* DSL (✔)
+* Holes (with a drill-bit in a chuck on the spindle) (✔)
+* Pockets (✘)
+* Facing (✘)
+* Manual gcode entry (✔)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gcodify'
+```
+
+And then just `$ bundle`.
+Or install it yourself:
+
+    $ gem install gcodify
+
+## Usage
+
+Write a new ruby file that requires `gcodify`:
+
+```ruby
+require 'gcodify'
+```
+
+Tell it that you want a program with certain features:
+
+```ruby
+program = GCodify.program do
+    hole :at=>[0, 0], depth=>0.13
+end
+puts program.to_gcode # output the program's gcode to stdout
+```
+
+Then run it: `$ ruby some_gcodify_script.rb > some_gcodify_script.gcode`.
+You just made a gcode program which makes a hole at the origin!
+
+## 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 tags, 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/ArchimedesPi/gcodify. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gcodify"
+
+# 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.
+
+require "pry"
+Pry.start

data/bin/setup

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

data/examples/square_of_holes.rb

@@ -0,0 +1,8 @@
+require 'gcodify'
+program = Gcodify.program do
+  hole :at=>[1, 1], :depth=>0.13
+  hole :at=>[1, -1], :depth=>0.13
+  hole :at=>[-1, -1], :depth=>0.13
+  hole :at=>[-1, 1], :depth=>0.13
+end
+puts program.to_gcode

data/gcodify.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gcodify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gcodify"
+  spec.version       = Gcodify::VERSION
+  spec.authors       = ["Liam Marshall"]
+  spec.email         = ["liam@cpan.org"]
+
+  spec.summary       = %q{Gcodify makes writing gcode by hand fun!}
+  spec.description   = %q{Gcodify is a Ruby DSL which generates gcode from a high-level,
+    Ruby-based description language. It's kind of like hand-written CAM.}
+  spec.homepage      = "https://github.com/ArchimedesPi/gcodify"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "yard"
+end

data/lib/gcodify.rb

@@ -0,0 +1,32 @@
+require "gcodify/version"
+require "gcodify/program"
+require "gcodify/opsmixin"
+require "gcodify/op"
+require "gcodify/ops/holeop"
+require "gcodify/ops/faceop"
+require "gcodify/ops/pocketop"
+require "gcodify/ops/gcodeop"
+require "gcodify/ops/dummyop"
+
+# {Gcodify} is the main module that contains all the code.
+# The only thing you'll be interacting with directly when you use it as a DSL is
+# the module method #program, which is passed a block as a DSL.
+# @example Using #program for a DSL
+#   aProgram = Gcodify.program do
+#     # some code here
+#   end
+module Gcodify
+  # Takes a block of operations and creates a new {Program} from them.
+  #
+  # @example Using it to create a {Program}
+  #   Gcodify.program do
+  #     hole :at=>[0, 0], :depth=>0.25
+  #   end
+  # @param block [Block] a block of operations (see Ops).
+  # @return [Program] a program created from `&block`
+  def self.program(&block)
+    prog = Program.new
+    prog.instance_eval(&block)
+    prog
+  end
+end

data/lib/gcodify/op.rb

@@ -0,0 +1,24 @@
+module Gcodify
+  # An Operation. An Operation is the unit of "doing". For instance, a drilled hole
+  # is a single {Op}, a circular pocket is a single {Op}, and so on.
+  # {Op}s are subclassed into things like HoleOp, PocketOp, etc., and each is responsible
+  # for storing data and each provides its own implementation of #to_gcode.
+  # @!attribute [r] options
+  #   @return [Hash] the options passed to the Op. Used for testing.
+  class Op
+    attr_reader :options
+
+    # @param options [Hash] a {Hash} of options to be passed in to the op
+    def initialize(options)
+      @options = options
+    end
+
+    # Converts the {Op} to Gcode. Each *{Op} has it's own implementation of #to_gcode,
+    # depending on what gcode it has to generate.
+    #
+    # @return [String] some gcode
+    def to_gcode
+      "" # Return an empty string for testing purposes.
+    end
+  end
+end

data/lib/gcodify/ops/dummyop.rb

@@ -0,0 +1,20 @@
+require 'gcodify/op'
+
+module Gcodify::Ops
+	# A passthrough {Op} for testing purposes.
+	# It contains @str which is the string passed during
+	# initialization, which will be returned by #to_gcode.
+  class DummyOp < Gcodify::Op
+  	# @param str [String] a string to be returned later for testing purposes
+    def initialize(str)
+      @str = str
+    end
+
+    # Returns the string that was passed in when initted.
+    #
+    # @return [String] the original dummy string
+    def to_gcode
+      @str
+    end
+  end
+end

data/lib/gcodify/ops/faceop.rb

@@ -0,0 +1,9 @@
+require 'gcodify/op'
+
+module Gcodify::Ops
+  class FaceOp < Gcodify::Op
+    def to_gcode
+      
+    end
+  end
+end

data/lib/gcodify/ops/gcodeop.rb

@@ -0,0 +1,18 @@
+require 'gcodify/op'
+
+module Gcodify::Ops
+	# An {Op} for passing through a line (or more) of GCode,
+	# since there are things that haven't been implemented yet
+	# that could be done in raw gcode.
+	# {GcodeOp} passes through a string in the same manner as DummyOp,
+	# but it adds '\n' to the end.
+  class GcodeOp < Gcodify::Op
+    def initialize(str)
+      @str = str
+    end
+
+    def to_gcode
+      @str+'\n'
+    end
+  end
+end

data/lib/gcodify/ops/holeop.rb

@@ -0,0 +1,27 @@
+require 'gcodify/op'
+
+module Gcodify::Ops
+	# A hole to be drilled.
+	# In @options, no :radius or :diameter is specified or necessary,
+	# since that's determined by the drill-bit that you put in the machine.
+  class HoleOp < Gcodify::Op
+  	# Special notice: @options[:r_position] is what the drilling cycle will rapid down to,
+  	# if not specified it's 0.2in
+  	# 
+  	# @param options [Hash] the options for the {HoleOp}
+  	def initialize(options)
+  		@options = options
+  		@options[:r_position] = @options[:r_position] || 0.2
+  	end
+
+  	# Creates the gcode. {HoleOp} uses canned drill cycles.
+  	# 
+  	# @return [String] the generated gcode
+    def to_gcode
+      gcode = "Z1.0\n"
+      gcode << "X#{@options[:at][0]} Y#{@options[:at][1]}"
+      gcode << "G99 G81 R#{@options[:r_position]} Z#{@options[:depth] + @options[:r_position]}\n"
+      gcode << "G80\n"
+    end
+  end
+end

data/lib/gcodify/ops/pocketop.rb

@@ -0,0 +1,9 @@
+require 'gcodify/op'
+
+module Gcodify::Ops
+  class PocketOp < Gcodify::Op
+    def to_gcode
+      
+    end
+  end
+end

data/lib/gcodify/opsmixin.rb

@@ -0,0 +1,39 @@
+# {OpsMixin} is used as a Mixin to {Program} for the DSL - all of the DSL's methods,
+# ie. hole, pocket, face, etc. are implemented here, and then `import`ed into
+# {Program}, for DRYness and reusability.
+# All methods contained in {OpsMixin} return a subclass of Op, ie. HoleOp, PocketOp, and so on.
+module Gcodify::OpsMixin
+  # options is a Hash
+  # standard stuff in options for all these functions
+  # not every op will use all of these.
+  # :at - where to put the feature
+  # :depth - how deep the feature should be
+  # :radius - radius of the feature
+  # :diameter - diameter of the feature, behavior is undefined when specified at the same time as :radius
+  # :peck - peck step depth for peck drilling
+  # :return_height - return height for pecking during peck drilling. if not specified, pecking will not return to a constant height
+  #
+  # @return [HoleOp] a hole-drilling operation
+  def hole(options)
+    @ops << Gcodify::Ops::HoleOp.new(options)
+  end
+
+  # (see #hole)
+  # @return [PocketOp] a pocketing operation
+  def circular_pocket(options)
+  end
+
+  # (see #hole)
+  # @return [FaceOp] a facing operation
+  def face(options)
+  end
+
+  # #gcode is a passthrough for gcode,
+  # used when Gcodify doesn't provide some feature of gcode
+  # that you might want to use.
+  #
+  # @param gcode [String] a line of gcode
+  def gcode(code)
+    @ops << Gcodify::Ops::GcodeOp(code)
+  end
+end

data/lib/gcodify/program.rb

@@ -0,0 +1,28 @@
+require "gcodify/opsmixin"
+
+module Gcodify
+  # Represents a GCode program. It contains a property @ops, which is an array
+  # of all the ops, in order, in the program.
+  class Program
+    # Access all ops in the program
+    attr_accessor :ops
+    # Mix in all the op functions for the DSL :D
+    include OpsMixin
+
+    def initialize
+      @ops = []
+    end
+
+    # Converts the {Program} to a Gcode string
+    #
+    # @return [String] the Gcode
+    def to_gcode
+      gcode = ""
+      @ops.each do |op|
+        # Append that Op's generated gcode to the full gcode string
+        gcode << op.to_gcode
+      end
+      gcode # Return the generated gcode
+    end
+  end
+end

data/lib/gcodify/version.rb

@@ -0,0 +1,3 @@
+module Gcodify
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: gcodify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Liam Marshall
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  Gcodify is a Ruby DSL which generates gcode from a high-level,
+      Ruby-based description language. It's kind of like hand-written CAM.
+email:
+- liam@cpan.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/square_of_holes.rb
+- gcodify.gemspec
+- lib/gcodify.rb
+- lib/gcodify/op.rb
+- lib/gcodify/ops/dummyop.rb
+- lib/gcodify/ops/faceop.rb
+- lib/gcodify/ops/gcodeop.rb
+- lib/gcodify/ops/holeop.rb
+- lib/gcodify/ops/pocketop.rb
+- lib/gcodify/opsmixin.rb
+- lib/gcodify/program.rb
+- lib/gcodify/version.rb
+homepage: https://github.com/ArchimedesPi/gcodify
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_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'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Gcodify makes writing gcode by hand fun!
+test_files: []