job_spec 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3441a2fabbdaac81b867f6b54a9839be629f280a
-  data.tar.gz: 952a87d62a7c4771e32b1b55a4ebcdede38de96c
+  metadata.gz: 6f22f45a0f55d70cc8e2654637dd04c308373118
+  data.tar.gz: c9f013e894133a601a24ec387aa7e2c5fb4ea0ef
 SHA512:
-  metadata.gz: 1048289aa27457a9908c9356707bcb2563dd067c037b3e26c0005b35d455e8f8ae762dfd82caf02a0faec7612cb59bb82fc9c161ca8b88719d9c3120baf4494b
-  data.tar.gz: 4fb1bf8b6cff0db7fb5658125dcd8919c7fcc08160f09492930cb1eab6c4abc66db26002cc1f3bad112fffd15c8deb86a3ba0e3fba4f500100c9458568b6e478
+  metadata.gz: df1d6ddf2fa1dfff30e7bc6d0ce272a48e4bca7f445b0b88e86fec78d4bb5809201a82ba6635c715234cfd68af04c16f5131387e724e4280e8da69daffcd7b84
+  data.tar.gz: b339882289260efc2e022c32a1c6673be2f29d0f21a1e55902bd4dacf521857ca6d47ed4ea34560b60b40f51784a7a3241597db5505db4764fb9df83125c4c0c

data/README.md

@@ -23,7 +23,7 @@ end
 Save that into a file `roles/engineer.rb`. Now from the command line in the directory that contains the `roles/` directory:
 
 ```
-jobspec build roles
+jobspec build --in=roles --out=dist
 ```
 
 And you will see your job roles printed out.

data/lib/job_spec/cli.rb

@@ -3,12 +3,21 @@ require 'job_spec'
 
 module JobSpec
   class CLI < Thor
-    desc 'build DIR', 'build roles in DIR'
-    def build(path = '.')
-      print "Building roles in #{path}... "
-      Dir[File.join(Dir.pwd, path, '**/*.rb')].each { |f| require f }
-      puts 'done.'
-      p Role.definitions
+    desc 'build', 'build roles in DIR out to DIR'
+    option :in, required: true
+    option :out, required: true
+    def build
+      puts "Looking in '#{options[:in]}' for roles... "
+      role_files(options[:in]).each do |f|
+        require f
+      end
+
+      FileUtils.mkdir_p(path_relative_to_pwd(options[:out]))
+      Role.definitions.each do |role|
+        puts "Saving #{role.name} to #{safe_role_out_path(role)}..."
+        File.write(safe_role_out_path(role), RenderAsMarkdown.new(role).render)
+      end
+      puts 'Finished.'
     end
 
     map %w(--version -v) => :version
@@ -19,3 +28,23 @@ module JobSpec
     end
   end
 end
+
+def path_relative_to_pwd(path)
+  File.expand_path(path, Dir.pwd)
+end
+
+def path_glob(dir)
+  path_relative_to_pwd(File.join(dir, '**/*.rb'))
+end
+
+def role_files(dir)
+  Dir[path_glob(dir)]
+end
+
+def safe_role_name(role)
+  "#{role.name.downcase.gsub(/[^a-z]+/, '')}.md"
+end
+
+def safe_role_out_path(role)
+  File.join(path_relative_to_pwd(options[:out]), safe_role_name(role))
+end

data/lib/job_spec/render_as_markdown.rb

@@ -0,0 +1,22 @@
+module JobSpec
+  class RenderAsMarkdown
+    attr_reader :role
+
+    def initialize(role)
+      @role = role
+    end
+
+    def render
+      markdown = []
+      markdown << "# #{role.name}"
+      markdown << role.description unless role.description.nil?
+
+      role.expectations.map(&:values).each do |(expectation, description)|
+        markdown << "## #{expectation.capitalize}"
+        markdown << description.capitalize unless description.nil? 
+      end
+
+      markdown.join("\n\n")
+    end
+  end
+end

data/lib/job_spec/role.rb

@@ -0,0 +1,53 @@
+module JobSpec
+  class Role
+    def self.definition(name, &block)
+      @definitions ||= []
+      @definitions << new(name, &block)
+    end
+
+    def self.definitions
+      @definitions
+    end
+
+    def initialize(name, &block)
+      @name = name
+      @expectations = []
+      instance_eval(&block) if block_given?
+    end
+
+    def name
+      @name
+    end
+
+    def description(description = nil)
+      @description = @description || description
+    end
+
+    def salary(range = nil)
+      @salary = @salary || range
+    end
+
+    def include(role_expectations)
+      @expectations.concat(role_expectations.to_a)
+    end
+
+    def expected(expectation, description = nil)
+      @expectations << { expectation: expectation, description: description }
+    end
+
+    def expectations
+      @expectations
+    end
+
+    class Expectations
+      def self.expected(expectation)
+        @role ||= Role.new(self.class.name)
+        @role.expected(expectation)
+      end
+
+      def self.to_a
+        @role.expectations
+      end
+    end
+  end
+end

data/lib/job_spec/version.rb

@@ -1,3 +1,3 @@
 module JobSpec
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/job_spec.rb

@@ -1,45 +1,2 @@
-module JobSpec
-  class Role
-    def self.definition(name, &block)
-      @definitions ||= []
-      @definitions << new(name, &block)
-    end
-
-    def self.definitions
-      @definitions
-    end
-
-    def initialize(name, &block)
-      @name = name
-      @expectations = []
-      instance_eval(&block) if block_given?
-    end
-
-    def salary(range = nil)
-      @salary = @salary || range
-    end
-
-    def include(role_expectations)
-      @expectations.concat(role_expectations.to_a)
-    end
-
-    def expected(expectation)
-      @expectations << expectation
-    end
-
-    def to_a
-      @expectations
-    end
-
-    class Expectations
-      def self.expected(expectation)
-        @role ||= Role.new(self.class.name)
-        @role.expected(expectation)
-      end
-
-      def self.to_a
-        @role.to_a
-      end
-    end
-  end
-end
+require 'job_spec/role'
+require 'job_spec/render_as_markdown'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: job_spec
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Luke Morton
@@ -83,6 +83,8 @@ files:
 - job_spec.gemspec
 - lib/job_spec.rb
 - lib/job_spec/cli.rb
+- lib/job_spec/render_as_markdown.rb
+- lib/job_spec/role.rb
 - lib/job_spec/version.rb
 homepage: https://github.com/madetech/job_spec
 licenses: