atd 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58bc7fc139c91e5ac91f51cf29e1c8638484bef7
-  data.tar.gz: a2956310bdbe71f6abb96cc840fad813815e0d5a
+  metadata.gz: e4b052a0c402077fa55a5c00e96db96c1963430a
+  data.tar.gz: 487ab2f6ce28280effbf0a1faff0d9b9959cd389
 SHA512:
-  metadata.gz: dce06c37ffcd1b2265052fc3b8149003f7a9e8e05e478f6e8a887496b34a3d0877d90c37040db783f226b3e3c28edd8b341b256e6022d188fbd173193588df17
-  data.tar.gz: d92f10cdc008a8f848178f36be680831786f738dfa759325d39bb24b4b7603cb5a64a5fb5072c2194304731cc3dddb132171c57cd925571f2e0c9482c8d48a84
+  metadata.gz: db837886aa4f434403f51f8f1d6cf796c6cfd0cc1e4ef095c336b967a0c5d22dc15f6d93e20afe7e3f8f897da6f7659d0e13be366a5fb4b73730c886f4996640
+  data.tar.gz: 4075dd51b6e64f6977c13b6d6d684ab66c5abca0c992b5efa0752c07b251835bd78e13984716c1fb7c3b1dbfee7cd90a04b851813da7b291a4b1fb53e222e7be

data/.gitignore

@@ -7,7 +7,8 @@
 /spec/reports/
 /tmp/
 .DS_Store
-/.idea/
+.idea
 coverage
 /*.gem
 /updated_README.md
+.dev-rubocop.yml

data/.gitlab-ci.yml

@@ -10,6 +10,10 @@ test:
   script:
     - bundle exec rake test
 
+rubocop:
+  script:
+    - rubocop
+
 pages:
   only:
     - master

data/.rubocop.yml

@@ -12,4 +12,16 @@ Style/ParallelAssignment:
   Enabled: false
 
 Style/Documentation:
+  Enabled: false
+
+Style/ModuleFunction:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Metrics:
+  Enabled: false
+
+Lint/UnifiedInteger:
   Enabled: false

data/.yardopts

@@ -0,0 +1 @@
+--exclude lib/extensions/

data/CHANGELOG

@@ -1,3 +1,13 @@
+Current Repo Version:
+
+v0.4.0
+    - Fixed an issue where routes without blocks wouldn't return status codes (#9)
+    - Allowed inline compilation as an alternative to the currently not working live compilation (#13), new inline version allows a hacky alternative (#17)
+    - Added new spaced syntax instead of dotted (`get post put "/", "Hello World"` instead of `get.post.put "/", "Hello World"`) (#10)
+    - Allowed the return value of the block to be the output if none is given (#15)
+    - Added Rack::Response to the @http variable (#13)
+    - Removed the `#is_file_string?` method in favor of simply checking if the file exists (#8)
+
 v0.3.2:
     - Really began using Gitlab issues
     - Synchronized development branch with master

data/README.md

@@ -1,6 +1,6 @@
 [![build status][build status badge]][build status link] [![coverage report][coverage report badge]][coverage report link] [![gem version][gem version badge]][gem version link] [![documentation coverage][documentation coverage badge]][documentation coverage link]
 
-[documentation coverage badge]: https://img.shields.io/badge/YARD%20coverage-93.18%-green.svg?style=flat-square
+[documentation coverage badge]: https://img.shields.io/badge/YARD%20coverage-100%-brightgreen.svg?style=flat-square
 [documentation coverage link]: http://izwick-schachter.gitlab.io/atd/YARD/coverage
 
 [build status badge]: https://gitlab.com/izwick-schachter/atd/badges/master/build.svg?style=flat-square
@@ -19,6 +19,7 @@
     - [Setup](#setup)
 - [Routing](#routing)
     - [Basic Routing](#basic-routing)
+	    - [Options Hash](#options-hash)
         - [Serving Files](#serving-files)
     - [Advanced Routing](#advanced-routing)
         - [DefaultApp](#defaultapp)
@@ -37,6 +38,7 @@
 - [Development](#development)
 - [Contributing](#contributing)
 
+
 # ATD
 
 ATD is a new web development backend framework for Ruby. It is built on top of rack, and is meant to be small easy and light. That is why it provides a very minimalist way of writing your backend. It treats a request as a request, without splitting it based on the HTTP method. 
@@ -125,6 +127,19 @@ Or, a simpler way would be with `:ignore`:
 request "/", "Hello World", ignore: :delete
 ```
 
+#### Options Hash
+
+You can pass various options through the options hash. The options hash is put as the last arguemtn when creating a route. For example: `request "/", "Hello World", option: value, other-option: value`
+
+Here is a list of the option which are currently valid and default values:
+
+```ruby
+status: 200 # Integer > 99 and < 1000. This will be the status code returned unless it is overridden by
+status_code: 200 # Same as status, but overrides. A slightly more verbose syntax.
+respond_to: nil # A list of HTTP methods as lowercase symbols which the route should respond to.
+ignore: nil # A list of HTTP methods as lowercase symbols which the route should not respond to.
+```
+
 #### Serving Files
 
 All files that you want to serve must be in the `assets` directory if they are, then it is simple to just create a route, and put the filename as the output. For example this will serve `assets/index.html`:
@@ -293,6 +308,22 @@ end
 
 The compilation works by going through the file extensions from last to first and running the compilations for each extension in that order. For example `file.html.erb` will first be compiled by the ERB compiler, then the output of the ERB compiler will be compiled by the HTML compiler.
 
+When you include a file with then `request "/route", "file.ext` it will be precompiled, but not compiled. If you want live compilation there are a few options. If you want live compilation and precompilation you will have to use the following syntax:
+
+```ruby
+request "/", "file.ext" do
+ live_compilation_method @http[:output]
+end
+```
+
+If you don't need precompilation and just want live compilation (the ususal use case) then you can just use the following format:
+
+```ruby
+request "/" do
+  live_compilation_method File.read("/assets/file.ext")
+end
+```
+
 ## Design Paradigms
 
 ATD is designed to fit into many different design paradigms, and to allow each person to adopt their own styles while leaving code readable to everyone. Do do this, the code was left fairly unstructured, but [here are a few examples from well known frameworks](https://gitlab.com/izwick-schachter/atd-examples.git).
@@ -309,4 +340,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitLab at https://gitlab.com/izwick-schachter/atd/issues. 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.
+Bug reports and pull requests are welcome on GitLab at https://gitlab.com/izwick-schachter/atd/issues. 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.
+
+### Contribution Policies
+
+Every constribution should correspond to a relevent issue which you keep up to date with notes on what you are working on. Each issues gets branched off of development and is named issue/<issue number>. When you are ready to merege it back in, make sure it passes both rubocop and all the tests. Each issue should get additional test if necessary.

data/atd.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["izwick.schachter@gmail.com"]
 
   spec.summary       = 'The assistant technical director of your website. It does the dirty work so you can see the big picture.'
-  spec.homepage      = "https://rubygems.org/gems/atd"
+  spec.homepage      = "https://gitlab.com/izwick-schachter/atd"
   spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'

data/lib/atd/routes.rb

@@ -16,53 +16,45 @@ module ATD
     module Compiler
       extend self
 
-      # Lists all file extenstions which have defined compiler methods
+      # Lists all file extentions which have defined compiler methods
       def filetypes
         instance_methods(true) - [:filetypes]
       end
     end
 
-    # This method is responsible for live compilation.
+    # This method is responsible for live compilation. It takes an ATD::Route as input, and returns either
+    # the filename if Route.output is a file or the Route.output string if Route.output is a string.
+    # It will also take the file and call the corresponding compilation method on it.
     def self.compile(name, contents)
-      return contents if name.nil? && !contents.is_a?(File)
-      name = File.basename(contents) if contents.is_a?(File)
-      name = name.split(".")
-      extensions = name - [name.first]
-      extensions.each do |extension|
-        contents = Compiler.send(extension, contents) if Compiler.filetypes.include? extension.to_sym
-      end
-      contents
+      return contents if name.nil?
+      contents = File.read(contents) if contents.is_a? File
+      parse(Compiler, name, contents)
     end
 
-    # This method is responsible for precompilation
-    def self.pre_parse(route)
-      output = route.output
-      name = output
-      return nil if output.nil?
-      if output.include?(".") || output.is_a?(File)
-        name = (output.is_a?(File) ? File.basename(output) : output)
-        file = read_file(output)
-        return name if file.nil?
-        file = precompile(name, file)
-        route.output = file
+    # This method is responsible for precompilation. It takes an ATD::Route as input, and returns either
+    # the filename if Route.output is a file or the Route.output string if Route.output is a string.
+    # It will also take the file and call the corresponding precompilation method on it.
+    # route.output is either a full, expanded file path, a file, or a string
+    def self.precompile(route, *opts)
+      return nil if route.output.nil?
+      if route.output.is_a?(File)
+        name = route.output.is_a?(File) ? File.basename(route.output) : route.output.dup
+        file = route.output.is_a?(File) ? route.output.dup : File.new(route.output)
+        route.output = parse(Precompiler, name, File.read(file)) if opts[0].nil? || opts[0]
+        return name
       end
-      name
+      route.output
     end
 
     class << self
       private
 
-      def read_file(output)
-        return File.read(File.join("assets/#{output}")) if output.is_a?(String) && File.exist?("assets/#{output}")
-        return File.read(output) if output.is_a? File
-      end
-
-      def precompile(name, contents)
+      def parse(type, name, contents)
         name = name.split(".")
         extensions = name - [name.first]
         extensions.each do |extension|
-          if Precompiler.filetypes.include? extension.to_sym
-            contents = Precompiler.send(extension, contents)
+          if type.filetypes.include? extension.to_sym
+            contents = type.send(extension, contents)
             extensions -= [extension]
           end
         end
@@ -71,3 +63,7 @@ module ATD
     end
   end
 end
+
+class Object
+  include ATD::Compilation::Compiler
+end

data/lib/atd/version.rb

@@ -1,3 +1,3 @@
 module ATD
-  VERSION = "0.3.2".freeze # The current version number of {ATD}.
+  VERSION = "0.4.0".freeze # The current version number of {ATD}.
 end

data/lib/atd.rb

@@ -4,7 +4,7 @@ require "webrick"
 require_relative "atd/builtin_class_modifications"
 require_relative "atd/routes"
 # Extension packs
-require_relative "extensions/precompilers"
+# require_relative "extensions/precompilers"
 
 # The assistant technical director of your website. It does the dirty work so you can see the big picture.
 module ATD
@@ -20,10 +20,11 @@ module ATD
   # So called because each instance stores a route, and will be called if that route is reached.
   # A route for the purposes of {ATD} is a parser that will be fed env in {ATD::App#call the rack app}.
   class Route
-    attr_accessor :args, :method, :block, :path, :output, :app, :actions
+    attr_accessor :args, :method, :block, :path, :output, :app, :actions, :status_code
 
     # The first two arguments must me the path and the output.
     def initialize(*args, &block)
+      @status_code = 200
       @method = [:get, :post, :put, :patch, :delete]
       @method = [] if args.last.is_a?(Hash) && !(args.last[:respond_to].nil? || args.last[:ignore].nil?)
       @app = :DefaultApp
@@ -66,6 +67,17 @@ module ATD
 
     [:get, :post, :put, :delete, :patch].each do |method|
       define_method(method) do |*args, &block|
+        # This conditional allows the syntax get post put "/", "Hello" because it passes
+        # the variables up through the different method calls.
+        if args.first.is_a?(ATD::Route)
+          @method = args.first.method
+          @output = args.first.output
+          @path = args.first.path
+          @args = args.first.args
+          @block = args.first.block
+          @app = args.first.app
+          @actions = args.first.actions
+        end
         @method = [method] if @method.length == 5
         @method += [method]
         @method.uniq!
@@ -81,6 +93,7 @@ module ATD
       routes[@path] = {}
       routes[@path][@method] = {}
       routes[@path][@method] = {
+        status_code: @status_code,
         output: @output,
         block: @block,
         args: @args,
@@ -91,22 +104,41 @@ module ATD
 
     private
 
-    # This should also manage @message at some point
+    # This should also manage @method at some point
     def parse_args(*args, &block)
       args.compact!
       args.flatten!
-      args.reject! { |arg| arg.is_a?(File) ? false : arg.empty? } # File doesn't respond to empty
+      args.reject! { |arg| arg.is_a?(File) || arg.is_a?(Proc) || arg ? false : arg.empty? } # File doesn't respond to empty
       @block = block
+      # This requires the format ATD::Route.new(path, route, args)
       @path ||= args.shift
       @output ||= args.shift
       @args = Array(@args).concat(args) unless args.nil?
+      # @output should be whatever the input is unless the input is a controller/action or the input is_file_string?
       if @output =~ /^\w*#\w*$/ # Check if @path is a controller#action combo
         controller, action = @output.split("#")
         @action = Object.const_get(controller.to_sym).method(action.to_sym)
         @output = @action.call
       end
-      @method += Array(args.last[:respond_to]) if args.last.is_a?(Hash) && !args.last[:respond_to].nil?
-      @method -= Array(args.last[:ignore]) if args.last.is_a?(Hash) && !args.last[:ignore].nil?
+      # TODO: Choose one! They all work... I think...
+      # Method 1:
+      target_location = []
+      caller_locations.each do |caller_location|
+        target_dir = File.dirname(caller_location.absolute_path.to_s)
+        target_location.push(target_dir) unless target_dir.include?(__dir__)
+      end
+      # Method 2:
+      target_location = caller_locations.reject do |caller_location|
+        File.dirname(caller_location.absolute_path.to_s).include? __dir__
+      end
+      output_full_path = "#{File.dirname(target_location[0].absolute_path)}/assets/#{@output}"
+      @output = File.new(output_full_path) if File.exist?(output_full_path) && !Dir.exist?(output_full_path)
+      if args.is_a?(Hash) || args.last.is_a?(Hash)
+        @method += Array(args.last[:respond_to]) unless args.last[:respond_to].nil?
+        @method -= Array(args.last[:ignore]) unless args.last[:ignore].nil?
+        @status_code = args.last[:status] unless args.last[:status].nil?
+        @status_code = args.last[:status_code] unless args.last[:status_code].nil?
+      end
       self
     end
   end
@@ -129,7 +161,7 @@ module ATD
 
       [:get, :post, :put, :patch, :delete].each do |i|
         define_method(i) do |*args, &block|
-          request.send(i, *args, &block)
+          request.send(i, *args, &block) # Makes get == r.get, post == r.post, etc.
         end
       end
 
@@ -162,20 +194,25 @@ module ATD
     def initialize(routes = [])
       @routes = {}
       Array(routes + self.class.routes).each do |route|
-        filename = ATD::Compilation.pre_parse(route) if route.args.last.nil? || route.args.last[:precompile].nil? || route.args.last[:precompile]
+        route = route.clone
+        filename = ATD::Compilation.precompile(route, (route.args.last.is_a?(Hash) ? route.args.last[:precompile] : nil))
         route_hash = route.to_h
         current_route = route_hash[route.path][route.method]
         current_route[:filename] = filename
         block = current_route[:block]
+        # An instance method must be defined from the block make it the same as the controller actions. We don't want to
+        # convert the controller actions to blocks because if we did that, we would have to take them out of scope to allow
+        # them to use the @http variables.
         current_route[:block] = define_singleton_method(block.object_id.to_s.tr("0-9", "a-j").to_sym, &block) unless block.nil?
         current_route[:block] = route.actions unless route.actions.nil?
         @routes = @routes.to_h.deep_merge(route_hash)
       end
     end
 
+    # Allows instance method route creation. Just another way of creating routes.
     def request(*args, &block)
       route = ATD::Route.new(*args, &block)
-      filename = ATD::Compilation.pre_parse(route) if route.args.last.nil? || route.args.last[:precompile].nil? || route.args.last[:precompile]
+      filename = ATD::Compilation.precompile(route, (route.args.last.is_a?(Hash) ? route.args.last[:precompile] : nil))
       route_hash = route.to_h
       route_hash[route.path][route.method][:filename] = filename
       @routes = @routes.to_h.deep_merge(route_hash)
@@ -198,10 +235,12 @@ module ATD
       @http = nil
       route = route(env)
       return error(404) if route.nil?
-      route[:output] = ATD::Compilation.compile(route[:filename], route[:output])
+      route[:output] = Compilation.compile(route[:filename], route[:output]) unless !route[:args].nil? && !route[:args].empty? && route[:args][0].is_a?(Hash) && route[:args][0][:compile] == false
       return [route[:status_code].to_i, Hash(route[:headers]), Array(route[:output])] if route[:block].nil?
-      http output: route[:output], request: Rack::Request.new(env), method: env["REQUEST_METHOD"]
-      run_block(route[:block])
+      http output: route[:output], request: Rack::Request.new(env), method: env["REQUEST_METHOD"], response: Rack::Response.new(env)
+      return_val = method(route[:block]).call
+      @http[:output] = return_val if @http[:output].nil?
+      [@http[:status_code].to_i, Hash(@http[:headers]), Array(@http[:output])]
     end
 
     private
@@ -212,11 +251,6 @@ module ATD
       @routes[env["PATH_INFO"]].include_in_key?(env["REQUEST_METHOD"].downcase.to_sym)
     end
 
-    def run_block(block)
-      method(block).call
-      [@http[:status_code].to_i, Hash(@http[:headers]), Array(@http[:output])]
-    end
-
     def http(additional_params)
       @http = { status_code: 200, headers: {} }.merge(additional_params)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: atd
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - ACecretMaster
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-12 00:00:00.000000000 Z
+date: 2016-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -160,6 +160,7 @@ files:
 - ".gitignore"
 - ".gitlab-ci.yml"
 - ".rubocop.yml"
+- ".yardopts"
 - CHANGELOG
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -174,7 +175,7 @@ files:
 - lib/atd/routes.rb
 - lib/atd/version.rb
 - lib/extensions/precompilers.rb
-homepage: https://rubygems.org/gems/atd
+homepage: https://gitlab.com/izwick-schachter/atd
 licenses:
 - MIT
 metadata:
@@ -195,7 +196,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: The assistant technical director of your website. It does the dirty work