shaf 0.1.0.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f841c557430b49c07e938734ae86d33572a7d6fa2b7ca5a65ae3c85d0a88cd65
+  data.tar.gz: b01be584adcba338f10942a79b80a2f55625383e880b119de5c5f9a53212e196
+SHA512:
+  metadata.gz: 4e9006af2484b780d9d41781d8060c58658c6c398152353e475d8f4c8832fc8397589d1798d9e805faa71bf8de537c63453493c8c67cae74190261b1a0236294
+  data.tar.gz: 2f62a554a41c79cd42a2669e6c844ece355db39a829754abe5dec7d81055949d88be6954ee4874b261181060374a06310b63790e7ed944edd521f8def10af942

data.tar.gz.sig

@@ -0,0 +1 @@
+�q''�@e-<���Í�[%݁�cHݖ��p�[ pj�u��[^����M@K7�!���v������V-u�J��ה}/��I8�:�Ti���g����ӥ��]R�6*��5"�机�-����3�Ex=�.mhHc�iF��]��7=�T��0},�$4Ϙ�O՝���*@X�s�/�es�f�����G7��;��"�}��4,Qso^�"#@]��Ч6��D
��C��T�!��x������

data/bin/shaf

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+
+require 'shaf/utils'
+require 'shaf/command'
+require 'shaf/settings'
+
+module Shaf
+  class Script
+    include Utils
+
+    def self.run
+      new.run
+    end
+
+    def run
+      check_customizations
+      return show_help if show_help?
+      Command::Factory.create(*ARGV).call
+    rescue RegistrableFactory::NotFoundError, Command::ArgumentError => e
+      puts e.message, "\n"
+      show_help
+      exit 1
+    rescue Utils::ProjectRootNotFound
+      puts "This command can only be executed inside a Shaf project directory. " \
+        "Please change directory and try again!"
+      exit 2
+    end
+
+    def show_help
+      puts "Usage: #{script_name} #{usage}"
+    end
+
+    def script_name
+      File.basename $0
+    end
+
+    def usage
+      Command::Factory.usage.join("\n            ")
+    end
+
+    def show_help?
+      ARGV.first =~ /-h/ 
+    end
+
+    def check_customizations
+      return unless project_root
+
+      in_project_root do
+        ENV['RACK_ENV'] ||= 'development'
+        next unless File.exist? 'config/customize.rb'
+        require 'config/customize'
+      end
+    end
+  end
+end
+
+Shaf::Script.run

data/lib/shaf.rb

@@ -0,0 +1,9 @@
+require 'shaf/version'
+require 'shaf/settings'
+require 'shaf/command'
+require 'shaf/app'
+require 'shaf/errors'
+require 'shaf/formable'
+require 'shaf/extensions'
+require 'shaf/helpers'
+require 'shaf/doc_model'

data/lib/shaf/api_doc.rb

@@ -0,0 +1,124 @@
+require 'shaf/api_doc/document'
+
+module Shaf
+  module ApiDoc
+    class Task
+      include Rake::DSL
+
+      attr_accessor :document_class, :source_dir, :html_output_dir, :yaml_output_dir
+
+      def initialize
+        yield self if block_given?
+        validate_attributes!
+        @document_class ||= Document
+        define_tasks
+      end
+
+      def validate_attributes!
+        raise "source_dir must be set!" unless source_dir
+        raise "html_output_dir must be configured in ApiDocTask" unless html_output_dir
+        raise "yaml_output_dir must be configured in ApiDocTask" unless yaml_output_dir
+      end
+
+      def define_tasks
+        namespace :doc do
+          desc "Generate API documentation"
+          task :generate do
+            files = Dir.glob(File.join(source_dir, "*.rb"))
+            files.each do |file|
+              read_file file do |doc|
+                next unless doc.has_enough_info?
+                doc.write_html @html_output_dir
+                doc.write_yaml @yaml_output_dir
+              end
+            end
+          end
+
+          desc "Remove generated documentation"
+          task :clean do
+            [
+              Dir.glob(File.join(@yaml_output_dir, "*.yml")),
+              Dir.glob(File.join(@html_output_dir, "*.html"))
+            ].flatten.each do |file|
+              File.unlink file
+            end
+          end
+        end
+      end
+
+      def read_file(file)
+        doc = document_class.new
+        comment = Comment.new
+
+        File.readlines(file).each do |line|
+          next if empty_line?(line)
+
+          if c = comment(line)
+            comment << c
+            next
+          end
+
+          parse_line(line, doc, comment)
+          comment = Comment.new
+        end
+
+        return doc unless block_given?
+        yield doc
+      end
+
+      def parse_line(line, doc, comment)
+        if model = model(line)
+          doc.model = model
+        elsif serializer_class = serializer_class(line)
+          doc.serializer_class = serializer_class
+        elsif policy = policy(line)
+          doc.policy = policy
+        elsif attr = attribute(line)
+          doc.attribute(attr, comment)
+        elsif rel = link(line)
+          doc.link(rel, comment)
+        elsif rel = curie(line)
+          doc.curie(rel, comment)
+        elsif name = embed(line)
+          doc.embedded(name, comment)
+        end
+      end
+
+      def empty_line?(line)
+        true if line[/\A[#\s*]*\Z/]
+      end
+
+      def serializer_class(line)
+        line[/\A\s*class\s*(\w+)\Z/, 1]
+      end
+
+      def model(line)
+        line[/\A\s*model\s*(?:::)?(\w+)/, 1]
+      end
+
+      def policy(line)
+        line[/\A\s*policy\s*(?:::)?(\w+)/, 1]
+      end
+
+      def comment(line)
+        line[/\A\s*#(.*)/, 1]
+      end
+
+      def attribute(line)
+        line[/\A\s*attribute[^s]\s*\(?\s*:(\w+)/, 1]
+      end
+
+      def link(line)
+        line[/\A\s*link\s*\(?\s*:'?([-:\w]+)'?/, 1]
+      end
+
+      def curie(line)
+        line[/\A\s*curie\s*\(?\s*:'?([-\w]+)'?/, 1]
+      end
+
+      def embed(line)
+        line[/\A\s*embed\s*\(?\s*:'?([-:\w]+)'?/, 1]
+      end
+    end
+  end
+end

data/lib/shaf/api_doc/comment.rb

@@ -0,0 +1,27 @@
+module Shaf
+  module ApiDoc
+    class Comment
+      def initialize
+        @indent = 0
+        @comment = ""
+      end
+
+      def to_s
+        @comment
+      end
+
+      def empty?
+        @comment.empty?
+      end
+
+      def <<(line)
+        @indent = line[/\A\s*/].size if empty?
+        @comment << "\n#{extract(line)}"
+      end
+
+      def extract(line)
+        line.sub(%r(\A\s{#{@indent}}), "")
+      end
+    end
+  end
+end

data/lib/shaf/api_doc/document.rb

@@ -0,0 +1,133 @@
+require 'fileutils'
+require 'yaml'
+require 'redcarpet'
+require 'redcarpet/render_strip'
+require 'shaf/api_doc/comment'
+
+module Shaf
+  module ApiDoc
+    class Document
+      attr_writer :model
+      attr_accessor :serializer_class, :policy, :attributes, :links, :curies, :embeds
+
+      def initialize
+        @model = nil
+        @serializer_class = nil
+        @policy = nil
+        @attributes = {}
+        @links = {}
+        @curies = {}
+        @embeds = {}
+        @md = {}
+      end
+
+      def model
+        @model || @serializer_class && @serializer_class.sub("Serializer", "")
+      end
+
+      def attribute(attr, comment)
+        @attributes[attr] = comment unless comment.empty?
+      end
+
+      def link(rel, comment)
+        @links[strip_curie(rel)] = comment unless comment.empty?
+      end
+
+      def curie(rel, comment)
+        @curies[rel] = comment unless comment.empty?
+      end
+
+      def embedded(name, comment)
+        @embeds[strip_curie(name)] = comment unless comment.empty?
+      end
+
+      def has_enough_info?
+        return false unless model
+        attributes.merge(links).merge(curies).any?
+      end
+
+      def generate_markdown!
+        return @md unless @md.empty?
+
+        generate_title!
+        generate_policy!
+        generate_section!(key: :attributes, heading: "Attributes")
+        generate_section!(key: :curies, heading: "Curies", sub_title: "rel")
+        generate_section!(key: :links, heading: "Links", sub_title: "rel")
+        generate_section!(key: :embeds, heading: "Embedded resources", sub_title: "rel")
+        @md[:doc]
+      end
+
+      def generate_yaml!
+        generate_markdown!
+        renderer = Redcarpet::Markdown.new(Redcarpet::Render::StripDown)
+
+        hash = {}
+        hash['policy'] = renderer.render(@md[:policy]).chomp if @md[:policy]
+
+        [:attributes, :curies, :links, :embeds].each do |key|
+          hash[key.to_s] = @md[key].map { |k, v| [k.to_s, renderer.render(v).chomp] }.to_h
+        end
+        hash.to_yaml
+      end
+
+      def to_markdown
+        # For some reason redcarpet don't like to surround my markdown code blocks
+        # with <pre> tags, so let's fix that here.
+        options = {autolink: true, fenced_code_blocks: true}
+        markdown = Redcarpet::Markdown.new(Redcarpet::Render::HTML, options)
+        html = markdown.render(generate_markdown!)
+        html.gsub!("<code>", "<pre><code>")
+        html.gsub!("</code>", "</code></pre>")
+        html
+      end
+
+      def write_html(output)
+        FileUtils.mkdir_p(output) unless Dir.exist? output
+        File.open(File.join(output, "#{model.downcase}.html"), "w") do |file|
+          file.write(to_markdown)
+        end
+      end
+
+      def write_yaml(output)
+        FileUtils.mkdir_p(output) unless Dir.exist? output
+        File.open(File.join(output, "#{model.downcase}.yml"), "w") do |file|
+          file.write(generate_yaml!)
+        end
+      end
+
+
+      private
+
+      def strip_curie(rel)
+        rel.split(':', 2)[1] || rel
+      end
+
+      def generate_title!
+        @md[:doc] = "##%s\n" % model.capitalize
+        @md[:title] = model.capitalize
+      end
+
+      def generate_policy!
+        return if policy.nil?
+        @md[:doc] << "###Policy\n#{policy}\n"
+        @md[:policy] = policy
+      end
+
+      def generate_section!(key:, heading:, sub_title: "")
+        list = send(key)
+        @md[:doc] << "####{heading}\n"
+        @md[key] = {}
+        if list.empty?
+          @md[:doc] << "This resource does not have any documented #{heading.downcase}\n"
+        else
+          sub_title << ": " unless sub_title.empty?
+          list.each do |name, comment|
+            @md[:doc] << "#######{sub_title}#{name.gsub('_', '-')}\n#{comment.to_s}\n"
+            @md[key][name] = comment.to_s.chomp
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shaf/app.rb

@@ -0,0 +1,22 @@
+require 'shaf/middleware'
+
+module Shaf
+  class App
+    class << self
+      def instance
+        create_instance unless defined?(@instance)
+        @instance
+      end
+
+      def create_instance
+        @instance = Sinatra.new
+        @instance.set :port, Shaf::Settings.port || 3000
+        @instance.use Shaf::Middleware::RequestId
+      end
+
+      def use(middleware)
+        instance.use middleware
+      end
+    end
+  end
+end

data/lib/shaf/command.rb

@@ -0,0 +1,42 @@
+require 'shaf/utils'
+require 'shaf/registrable_factory'
+
+module Shaf
+  module Command
+
+    class ArgumentError < StandardError; end
+
+    class Factory
+      extend RegistrableFactory
+    end
+
+    class Base
+      include Utils
+
+      attr_reader :args
+
+      class << self
+        def inherited(child)
+          Factory.register(child)
+        end
+
+        def identifier(*ids)
+          @identifiers = ids.flatten
+        end
+
+        def usage(str = nil, &block)
+          @usage = str || block
+        end
+      end
+
+      def initialize(*args)
+        @args = args.dup
+      end
+    end
+  end
+end
+
+require 'shaf/command/new'
+require 'shaf/command/server'
+require 'shaf/command/console'
+require 'shaf/command/generate'

data/lib/shaf/command/console.rb

@@ -0,0 +1,17 @@
+require 'irb'
+
+module Shaf
+  module Command
+    class Console < Base
+
+      identifier %r(\Ac(onsole)?\Z)
+      usage 'console'
+
+      def call
+        bootstrap
+        ARGV.clear
+        IRB.start
+      end
+    end
+  end
+end