keyboard_reactor 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62e9a2af4cd2ff17f01715eb17a19edcea9633a2
-  data.tar.gz: cf9acbce997542c2214641568c15308bd1170f10
+  metadata.gz: 1c56aa60987558a2554ede6c15b455ac7b86938d
+  data.tar.gz: ff59517928b78ebd6d6581d43fa41a97846a9433
 SHA512:
-  metadata.gz: 94ac7abbeed0e499508e568546b0e3f5d4509a89f4065928f9b30f63e6c5d293ba5c68a7af7b63d82202322b8272dde1483986c0d1530d5faf84d905adea8644
-  data.tar.gz: bcacded08d754ebc1ae1c87440c0826b58d50835a7d07856e3253d8f5af0a40d0f2e766844d5e554848a727025d55eb690dc9492d4dba8e7b3eb1f3db81451d7
+  metadata.gz: f993251271d1657b2f563c3e8aa268479c4391678bff8fe432badc91fbe467032d1e14f47312fb4647ede694994aaf8f87399dbc02918aed1fe9ffbd9570a4cc
+  data.tar.gz: 22cce8db810228df008752dffe6597cf38f61de2717e3e8cc77cf7a0d5d4589a24a6dd14b3143a2aad7f796e65edc7f798b21d2a87cb9593a6ca7fd66d876911

data/README.md

@@ -10,12 +10,15 @@ Reactor uses the awesome [qmk_firmware](http://github.com/jackhumbert/qmk_firmwa
 ## General process
 
 - Take JSON input
-- Generate a .c template file base on the JSON and the liquid template named for the type value in in the JSON
-- Return the .hex file created from running make with that file
+- Generate a .c template file based on the JSON and the liquid template. Name it something unique
+- Create a hex file by compiling that c file. Name it something unique too
+- Read .hex file and return it
 
 # Local development
 
-You can run the tests with `be guard` - which will watch for changes in ruby files and run whenever they do
+You can run the tests with `be guard` - which will watch for changes in ruby files and run whenever they do.
+
+Testing is done in ruby 2.2.2
 
 ## Updating the firmware
 
@@ -49,7 +52,9 @@ To update the subtree from the qmk_firmware repository, pull the updates from qm
 
 #### Linux
 
-TBD
+Using the instructions from [the teensy loader build environment](https://www.pjrc.com/teensy/gcc.html):
+
+    sudo apt-get install gcc-avr binutils-avr avr-libc
 
 #### Mac OSX
 
@@ -69,11 +74,3 @@ Then run `make` for the default keymap, or
     
 for your own keymap. This requires a files keymap_yourown.c in the subfolder keymaps.
 You should end up with a `ergodox_ez.hex` file, which you can use with the [Teensy loader](http://www.pjrc.com/teensy/loader_cli.html) or [Teensy GUI](https://www.pjrc.com/teensy/loader.html)
-
-#### Windows
-
-TBD
-
-## License
-
-MIT, see LICENSE

data/lib/keyboard_reactor/output.rb

@@ -5,19 +5,19 @@ module KeyboardReactor
       @id = "#{(Time.now.to_f * 100).round}reactor"
     end
 
-    attr_reader :tmp_dir, :keyboard_hash, :find_type, :id
-    attr_writer :keyboard_type
+    attr_reader :tmp_dir, :keyboard_hash, :find_kind, :id
+    attr_writer :keyboard_kind
 
     def self.relative_path(path)
       File.expand_path(path, BASE_DIR)
     end
 
-    def self.known_types
+    def self.known_kinds
       COLUMNS.keys
     end
 
     def firmware_path
-      self.class.relative_path("firmware/keyboard/#{keyboard_type}")
+      self.class.relative_path("firmware/keyboard/#{keyboard_kind}")
     end
 
     def c_file_path
@@ -28,21 +28,21 @@ module KeyboardReactor
       @hex_file_path ||= self.class.relative_path("#{firmware_path}/#{@id}.hex")
     end
 
-    def keyboard_type
-      @keyboard_type ||= @keyboard_hash['type']
-      return @keyboard_type.to_s if self.class.known_types.include?(@keyboard_type)
-      fail "Unknown keyboard type '#{@keyboard_type}', not one of #{self.class.known_types}"
+    def keyboard_kind
+      @keyboard_kind ||= @keyboard_hash['kind']
+      return @keyboard_kind.to_s if self.class.known_kinds.include?(@keyboard_kind)
+      fail "Unknown keyboard kind '#{@keyboard_kind}', not one of #{self.class.known_kinds}"
     end
 
     def layout_template
-      path = "./keyboard_reactor/templates/#{keyboard_type}.liquid"
+      path = "./keyboard_reactor/templates/#{keyboard_kind}.liquid"
       File.read(self.class.relative_path(path))
     end
 
     def c_file
       Liquid::Template.parse(layout_template)
         .render(
-          'columns' => COLUMNS[keyboard_type],
+          'columns' => COLUMNS[keyboard_kind],
           'layout' => @keyboard_hash
         )
     end
@@ -52,8 +52,6 @@ module KeyboardReactor
     end
 
     def hex
-      return default_hex
-
       write_c_file
       # Override the default target with our ID so that we create unique files
       `cd #{firmware_path.to_s} && make clean && TARGET=#{id} make -e KEYMAP="#{id}"`
@@ -70,7 +68,7 @@ module KeyboardReactor
     end
 
     def default_hex
-      @hex_file_path = "#{firmware_path}/#{keyboard_type}.hex"
+      @hex_file_path = "#{firmware_path}/#{keyboard_kind}.hex"
       `cd #{firmware_path.to_s} && make clean && make KEYMAP="default"`
       read_hex_file
     end

data/lib/keyboard_reactor/version.rb

@@ -1,3 +1,3 @@
 module KeyboardReactor
-  VERSION = '0.0.3'
+  VERSION = '0.0.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keyboard_reactor
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - sethherr
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-31 00:00:00.000000000 Z
+date: 2016-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json