scad_bundler 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1304333190d408399a3a705c5e1185c7876b8d94804487a4187604545adb960b
+  data.tar.gz: 64dcf78eb0c410f83574ebfb6d29fc91028ac20e7f47e931a2ddc7b81873676a
+SHA512:
+  metadata.gz: ed938e5c2e190795c0be88e8e95a017f20833bc594958e74c54b99f2f2aabe247d1301c752aa1d5d978fba56fc2678dffcf529831cabd001678c847b9a65be95
+  data.tar.gz: b055b7aa77639fe1cc719a389374f07f595a07f8fc9fc34edc05e7ae194cc839f7b21b9c17e15b9113a53df03068443dce10240024cf71f1aefd041b12b71a5b

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in scad_bundler.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    scad_bundler (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.11.1)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  scad_bundler!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Joe Francis
+
+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,88 @@
+# scad_bundler
+
+scad_bundler is a package manager for [OpenSCAD](http://openscad.org).  It's based on [RubyGems](https://rubygems.org) and uses [Bundler](https://bundler.io) under the hood.
+
+scad_bundler is a fully-featured package manager that:
+
+* downloads and installs OpenSCAD libraries needed by your project
+* resolves compatible versions of dependencies of your libraries
+* modifies environment variables to tell OpenSCAD where to find your libraries
+* is capable of downloading libraries directly GitHub, off rubygems.org, from a private repository, or local files on your computer
+
+## Installation
+
+You will need to have Ruby and RubyGems installed to use scad_bundler.
+
+Once RubyGems is installed, install `scad_bundler`:
+
+    $ gem install scad_bundler
+
+## Usage
+
+Similar to how bundler works, scad_bundler dependencies are defined in a Scadfile and resolved versions are locked in a Scadfile.lock.  To initialize your project and create and empty `Scadfile`
+
+    $ scad_bundle init
+
+Dependencies can be declared inside your `scadfile` using bundler's [full capabilities](https://bundler.io/gemfile.html) for a Gemfile.  FIXME: add a simple example, and go into how version constraints work.
+
+Once your dependencies have been listed, you can install them via:
+
+    $ scad_bundle install
+
+scad_bundler will then work out compatible versions of the libraries and install them on your system.  Then to fire up OpenSCAD:
+
+    $ scad_bundle exec openscad
+
+scad_bundler will then start `openscad` with the `OPENSCADPATH` environment set properly to use all of your libraries.
+
+To upgrade libraries, simple call:
+
+    $ scad_bundle update
+
+## Conventions and Best Practices for creating OpenSCAD Libraries
+
+FIXME: explain how to create a library and what conventions is should follow.
+
+## Motivation
+
+The motivation for scad_bundler is simple - create a first-class package manager for OpenSCAD to help advance the entire OpenSCAD ecosystem.
+
+Having a package manager is an essential feature of modern languages, and OpenSCAD should be no different. A really solid package manager will allow us to build up components and utilities to simplify designs, so that users need not choose between starting at zero and manually wrangling files from Thingiverse.  Having this base of knowledge will also help the OpenSCAD community to better identify and codify best practices for sharing code and designing models.
+
+That package manager needs to support versioning and version constraints, so that packages can evolve over time and ship breaking changes rather than stagnate on the first API to coalesce.
+
+It is my hope that building this knowledge base will also help the community hash out common problems "in userspace" either completely or substantially, so that the scope of changes proposed for OpenSCAD itself can be smaller, more focused, and better tested than many proposals that come up now.
+
+
+## FAQ
+
+#### Why build on RubyGems and bundler?
+
+RubyGems and bundler are a very stable base to build upon, and include very advanced support for specifying compatible library versions and then resolving those dependencies.  Using this foundation is much more expedient than starting from scratch.
+
+#### Why host openscad packages on rubygems.org?
+
+Hosting a package repository is *hard* work and very security sensitive. Using another open source project's repository get us going from day one, and frees us from all of the infrastructure and security headaches hosting our own would entail.  If you don't want to post your package as a gem on rubygems.org, it's perfectly fine to post it on github and direct people to use that.  Long term, it would be ideal to host a separate package repository but there's nothing wrong with starting out like this.
+
+#### Why pass library information via an environment variable?
+
+The initial goal of scad_bundler was to create a package manager that worked without requiring any modifications to OpenSCAD.  Long-term, we would love to integrate more tightly with OpenSCAD, but this absolutely works for now.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lostapathy/scad_bundler.
+
+## TODO
+
+* Better docs on how to package a new library
+* Completely abstract away the fact that this is ruby-based over the long-term.
+* Change the 'gem' declaration in Scadfile to something that isn't a ruby-centric.
+* Decouple us from the 'gemspec' format.  In a perfect world, we'd have our own simplified package format that generated all the extra stuff RubyGems needs but scad_bundler does not.  It would also apply some conventions and best practices to the libraries to make other goals easier to accomplish.
+* Long term, create an alternate package repository from RubyGems.org that only lists OpenSCAD packages and adds functionality more applicable to 3d modeling.
+* Figure out a cleaner way to integrate this with OpenSCAD than just setting an environment variable on OpenSCAD startup.
+* Better define what features we could add to OpenSCAD to better support libraries (i.e., namespacing support).
+* Provide a hook in the library spec to specify a minimum OpenSCAD version to use the library.
+
+## 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 "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "scad_bundler"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/scad_bundle

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Use Scadfile instead of Gemfile
+# FIXME: could this be done in a less hacked way?
+ENV['BUNDLE_GEMFILE'] = 'Scadfile'
+
+require 'bundler'
+require 'shellwords'
+
+
+# FIXME: ideally we would delegate this all directly to bundler
+# We do want to wrap bundler and not just use it directly, to limit
+# what aspects of bundler are exposed and keep our options open for
+# different implementations later.
+command = ARGV.shift
+
+if command != 'init' && ! File.exists?('Scadfile')
+  puts 'Could not find Scadfile'
+  exit(1)
+end
+
+case command
+when 'init'
+  # Setup new Scadfile
+  if File.exists?('Scadfile')
+    puts 'Scadfile already exists!'
+    exit(1)
+  end
+
+  File.open('Scadfile', 'w') { |file| file.write("source \"https://rubygems.org\"\n\n# gem 'openscad_util', git: 'https://github.com/lostapathy/openscad-libs'\n") }
+when 'exec'
+  # Run the specified command with OPENSCADPATH set in the environment
+  specs = Bundler.load.specs.reject {|s| s.name == "bundler" }.sort_by(&:name)
+  lib_paths = specs.map { |spec| spec.full_gem_path }
+  env = {'OPENSCADPATH' => lib_paths.join(':')}
+
+  args = ARGV.map { |x| Shellwords.escape(x) }
+  exec( env, args.join(' ')  )
+when 'update'
+  # Update packages
+  exec( { 'BUNDLE_GEMFILE' => 'Scadfile' }, %w[bundle update])
+when 'install'
+  # Install packages
+  exec( { 'BUNDLE_GEMFILE' => 'Scadfile' }, %w[bundle install])
+else
+  puts "Invalid command: #{command}"
+  exit(1)
+end

data/bin/setup

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

data/lib/scad_bundler/version.rb

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

data/lib/scad_bundler.rb

@@ -0,0 +1,5 @@
+require "scad_bundler/version"
+
+module ScadBundler
+  # Your code goes here...
+end

data/scad_bundler.gemspec

@@ -0,0 +1,25 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "scad_bundler/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "scad_bundler"
+  spec.version       = ScadBundler::VERSION
+  spec.authors       = ["Joe Francis"]
+  spec.email         = ["joe@lostapathy.com"]
+
+  spec.summary       = %q{A package manager for OpenSCAD}
+  spec.description   = %q{A package manager that leverages the power of RubyGems to package OpenSCAD libraries.}
+  spec.homepage      = "https://github.com/lostapathy/scad_bundler"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  #spec.bindir        = "exe"
+  spec.executables   = ['scad_bundle']
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: scad_bundler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joe Francis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+description: A package manager that leverages the power of RubyGems to package OpenSCAD
+  libraries.
+email:
+- joe@lostapathy.com
+executables:
+- scad_bundle
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/scad_bundle
+- bin/setup
+- lib/scad_bundler.rb
+- lib/scad_bundler/version.rb
+- scad_bundler.gemspec
+homepage: https://github.com/lostapathy/scad_bundler
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: A package manager for OpenSCAD
+test_files: []