Merge pull request #13 from mamantoha/refactor

MechanizeCr -> Mechanize

spec/form/select_list_spec.cr

@@ -27,7 +27,7 @@ describe "Form Fields Select List" do
     form.selectboxes.size.should eq 1
   end
 
-  selectbox = form.selectboxes[0].as(MechanizeCr::FormContent::SelectList)
+  selectbox = form.selectboxes[0].as(Mechanize::FormContent::SelectList)
 
   it "returns selectbox options size" do
     selectbox.options.size.should eq 3

src/mechanize.cr

@@ -35,7 +35,7 @@ class Mechanize
   }
 
   def initialize
-    @agent = MechanizeCr::HTTP::Agent.new
+    @agent = Mechanize::HTTP::Agent.new
     @agent.context = self
     @agent.user_agent = USER_AGENT["Mechanize"]
   end
@@ -51,8 +51,8 @@ class Mechanize
   #   headers: HTTP::Headers{"Foo" => "Bar"})
   # ```
   def get(uri : String | URI,
-          headers = HTTP::Headers.new,
+          headers = ::HTTP::Headers.new,
-          params : Hash(String, String | Array(String)) = Hash(String, String).new) : MechanizeCr::Page
+          params : Hash(String, String | Array(String)) = Hash(String, String).new) : Mechanize::Page
     method = :get
     page = @agent.fetch uri, method, headers, params
     add_to_history(page)
@@ -71,17 +71,17 @@ class Mechanize
   #   headers: HTTP::Headers{"Foo" => "Bar"})
   # ```
   def post(uri : String | URI,
-           headers = HTTP::Headers.new,
+           headers = ::HTTP::Headers.new,
-           query : Hash(String, String | Array(String)) = Hash(String, String).new) : MechanizeCr::Page
+           query : Hash(String, String | Array(String)) = Hash(String, String).new) : Mechanize::Page
     node = Node.new
     node["method"] = "POST"
     node["enctype"] = "application/x-www-form-urlencoded"
 
-    form = MechanizeCr::Form.new(node)
+    form = Mechanize::Form.new(node)
     query.each do |k, v|
       node = Node.new
       node["name"] = k
-      form.fields << MechanizeCr::FormContent::Field.new(node, v)
+      form.fields << Mechanize::FormContent::Field.new(node, v)
     end
     post_form(uri, form, headers)
   end
@@ -125,18 +125,18 @@ class Mechanize
   # get the page mechanize last visited.
   #
   # ```
-  # agent.current_page => #<MechanizeCr::Page>
+  # agent.current_page => #<Mechanize::Page>
   # ```
-  def current_page : MechanizeCr::Page
+  def current_page : Mechanize::Page
     @agent.current_page
   end
 
   # get the latest page recorded in history, and the page is deleted from history.
   #
   # ```
-  # agent.back => #<MechanizeCr::Page>
+  # agent.back => #<Mechanize::Page>
   # ```
-  def back : MechanizeCr::Page
+  def back : Mechanize::Page
     @agent.history.pop
   end
 
@@ -151,7 +151,7 @@ class Mechanize
   # form.field_with("foo").value = "bar"
   # agent.submit(form)
   # ```
-  def submit(form, button = nil) : MechanizeCr::Page?
+  def submit(form, button = nil) : Mechanize::Page?
     form.add_button_to_query(button) if button
     case form.method.upcase
     when "POST"
@@ -162,19 +162,19 @@ class Mechanize
   # parse response. it is used internally.
   def parse(uri, response, body)
     code = response.not_nil!.status_code
-    MechanizeCr::Page.new(uri, response, body, code, self)
+    Mechanize::Page.new(uri, response, body, code, self)
   end
 
-  # get the history (`MechanizeCr::History`).
+  # get the history (`Mechanize::History`).
   # the requests mechanize send is recorded in this history.
   # ```
-  # agent.history => #<MechanizeCr::History>
+  # agent.history => #<Mechanize::History>
   # ```
-  def history : MechanizeCr::History
+  def history : Mechanize::History
     @agent.history
   end
 
-  # add page to history (`MechanizeCr::History`).
+  # add page to history (`Mechanize::History`).
   #
   # if you send request, mechanize calls this method and records page,
   # so you don't need to call this on your own.
@@ -207,7 +207,7 @@ class Mechanize
   # link = page.links.first
   # page2 = agent.click(link)
   # ```
-  def click(link : MechanizeCr::PageContent::Link) : MechanizeCr::Page
+  def click(link : Mechanize::PageContent::Link) : Mechanize::Page
     href = link.href
     get href
   end
@@ -219,13 +219,13 @@ class Mechanize
   # ```
   def download(uri : URI | String,
                filename : String,
-               headers = HTTP::Headers.new,
+               headers = ::HTTP::Headers.new,
                params : Hash(String, String | Array(String)) = Hash(String, String).new)
     transact do
       page = get(uri, headers, params)
       case page
-      when MechanizeCr::File
+      when Mechanize::File
-        File.write(filename, page.body)
+        ::File.write(filename, page.body)
       end
     end
   end
@@ -233,7 +233,7 @@ class Mechanize
   # Runs given block, then resets the page history as it was before.
   private def transact
     # save the previous history status.
-    history_backup = MechanizeCr::History.new(@agent.history.max_size, @agent.history.array.dup)
+    history_backup = Mechanize::History.new(@agent.history.max_size, @agent.history.array.dup)
     begin
       yield self
     ensure
@@ -243,7 +243,7 @@ class Mechanize
   end
 
   # send POST request from form.
-  private def post_form(uri, form, headers) : MechanizeCr::Page
+  private def post_form(uri, form, headers) : Mechanize::Page
     cur_page = form.page || (current_page unless history.empty?)
 
     request_data = form.request_data

src/mechanize/errors/base_error.cr

@@ -1,3 +1,5 @@
 # Base Error class
-class MechanizeCr::Error < RuntimeError
+class Mechanize
+  class Error < RuntimeError
+  end
 end

src/mechanize/errors/element_not_found_error.cr

@@ -1,6 +1,6 @@
 require "./base_error"
 
-class MechanizeCr::ElementNotFoundError < MechanizeCr::Error
+class Mechanize::ElementNotFoundError < Mechanize::Error
   getter element : Symbol
   getter conditions : String
 

src/mechanize/file.cr

@@ -1,12 +1,14 @@
 require "http/client"
 
-class MechanizeCr::File
+class Mechanize
-  # property :body, :filename
+  class File
-  property :body, :code, uri, :response
+    # property :body, :filename
+    property :body, :code, uri, :response
 
-  def initialize(uri : URI, response : ::HTTP::Client::Response, body : String, code : Int32)
+    def initialize(uri : URI, response : ::HTTP::Client::Response, body : String, code : Int32)
-    @uri = uri
+      @uri = uri
-    @body = body
+      @body = body
-    @code = code
+      @code = code
+    end
   end
 end

src/mechanize/form.cr

@@ -8,33 +8,33 @@ require "./form/button"
 require "./form/select_list"
 require "./utils/element_matcher"
 
-class MechanizeCr::Form
+class Mechanize::Form
-  include MechanizeCr::ElementMatcher
+  include Mechanize::ElementMatcher
 
   getter node : Node | Lexbor::Node
-  getter fields : Array(FormContent::Field)
+  getter fields : Array(Mechanize::FormContent::Field)
-  getter checkboxes : Array(FormContent::CheckBox)
+  getter checkboxes : Array(Mechanize::FormContent::CheckBox)
-  getter radiobuttons : Array(FormContent::RadioButton)
+  getter radiobuttons : Array(Mechanize::FormContent::RadioButton)
-  getter selectboxes : Array(FormContent::MultiSelectList)
+  getter selectboxes : Array(Mechanize::FormContent::MultiSelectList)
-  getter buttons : Array(FormContent::Button)
+  getter buttons : Array(Mechanize::FormContent::Button)
   getter enctype : String
   getter method : String
   getter name : String
-  getter page : Page?
+  getter page : Mechanize::Page?
   property action : String
 
-  def initialize(node : Node | Lexbor::Node, page : Page? = nil)
+  def initialize(node : Node | Lexbor::Node, page : Mechanize::Page? = nil)
     @enctype = node.fetch("enctype", "application/x-www-form-urlencoded")
     @node = node
-    @fields = Array(FormContent::Field).new
+    @fields = Array(Mechanize::FormContent::Field).new
-    @checkboxes = Array(FormContent::CheckBox).new
+    @checkboxes = Array(Mechanize::FormContent::CheckBox).new
-    @radiobuttons = Array(FormContent::RadioButton).new
+    @radiobuttons = Array(Mechanize::FormContent::RadioButton).new
-    @selectboxes = Array(FormContent::MultiSelectList).new
+    @selectboxes = Array(Mechanize::FormContent::MultiSelectList).new
-    @buttons = Array(FormContent::Button).new
+    @buttons = Array(Mechanize::FormContent::Button).new
     @action = node.fetch("action", "")
     @method = node.fetch("method", "GET").upcase
     @name = node.fetch("name", "")
-    @clicked_buttons = Array(FormContent::Button).new
+    @clicked_buttons = Array(Mechanize::FormContent::Button).new
     @page = page
     # @mech             = mech
 
@@ -68,25 +68,25 @@ class MechanizeCr::Form
       type = (html_node["type"]? || "text").downcase
       case type
       when "checkbox"
-        checkboxes << FormContent::CheckBox.new(html_node, self)
+        checkboxes << Mechanize::FormContent::CheckBox.new(html_node, self)
       when "radio"
-        radiobuttons << FormContent::RadioButton.new(html_node, self)
+        radiobuttons << Mechanize::FormContent::RadioButton.new(html_node, self)
       when "button"
-        buttons << FormContent::Button.new(html_node, @node)
+        buttons << Mechanize::FormContent::Button.new(html_node, @node)
       when "submit"
-        buttons << FormContent::SubmitButton.new(html_node, @node)
+        buttons << Mechanize::FormContent::SubmitButton.new(html_node, @node)
       when "reset"
-        buttons << FormContent::ResetButton.new(html_node, @node)
+        buttons << Mechanize::FormContent::ResetButton.new(html_node, @node)
       when "image"
-        buttons << FormContent::ImageButton.new(html_node, @node)
+        buttons << Mechanize::FormContent::ImageButton.new(html_node, @node)
       when "text"
-        fields << FormContent::Text.new(html_node)
+        fields << Mechanize::FormContent::Text.new(html_node)
       when "hidden"
-        fields << FormContent::Hidden.new(html_node)
+        fields << Mechanize::FormContent::Hidden.new(html_node)
       when "textarea"
-        fields << FormContent::Textarea.new(html_node)
+        fields << Mechanize::FormContent::Textarea.new(html_node)
       else
-        fields << FormContent::Field.new(html_node)
+        fields << Mechanize::FormContent::Field.new(html_node)
       end
     end
 
@@ -149,7 +149,7 @@ class MechanizeCr::Form
         # raise Mechanize::Error,
         #      "radiobuttons #{values} are checked in the #{name} group, " \
         #      "only one is allowed"
-        raise MechanizeCr::Error.new
+        raise Mechanize::Error.new
       else
         successful_controls << checked.first unless checked.empty?
       end

src/mechanize/form/button.cr

@@ -1,4 +1,4 @@
-class MechanizeCr::FormContent::Button < MechanizeCr::FormContent::Field
+class Mechanize::FormContent::Button < Mechanize::FormContent::Field
   getter form_node : Node | Lexbor::Node
 
   def initialize(node : Node | Lexbor::Node, form_node : Node | Lexbor::Node, value = nil)

src/mechanize/form/check_box.cr

@@ -1,4 +1,4 @@
-class MechanizeCr::FormContent::CheckBox < MechanizeCr::FormContent::RadioButton
+class Mechanize::FormContent::CheckBox < Mechanize::FormContent::RadioButton
   def check
     @checked = true
   end

src/mechanize/form/field.cr

@@ -1,4 +1,4 @@
-class MechanizeCr::FormContent::Field
+class Mechanize::FormContent::Field
   property value : String?
   getter name : String
   getter type : String
@@ -29,7 +29,7 @@ class MechanizeCr::FormContent::Field
 
   def inspect # :nodoc:
     "[%s:0x%x type: %s name: %s value: %s]" % [
-      self.class.name.sub(/MechanizeCr::FormContent::/, "").downcase,
+      self.class.name.sub(/Mechanize::FormContent::/, "").downcase,
       object_id, type, name, value,
     ]
   end

src/mechanize/form/hidden.cr

@@ -1,2 +1,2 @@
-class MechanizeCr::FormContent::Hidden < MechanizeCr::FormContent::Field
+class Mechanize::FormContent::Hidden < Mechanize::FormContent::Field
 end

src/mechanize/form/image_button.cr

@@ -1,2 +1,2 @@
-class MechanizeCr::FormContent::ImageButton < MechanizeCr::FormContent::Button
+class Mechanize::FormContent::ImageButton < Mechanize::FormContent::Button
 end

src/mechanize/form/multi_select_list.cr

@@ -1,6 +1,6 @@
 require "./option"
 
-class MechanizeCr::FormContent::MultiSelectList
+class Mechanize::FormContent::MultiSelectList
   getter node : Lexbor::Node
   getter name : String
   getter type : String
@@ -54,7 +54,7 @@ class MechanizeCr::FormContent::MultiSelectList
 
   def inspect # :nodoc:
     "[%s:0x%x type: %s name: %s values: [%s]]" % [
-      self.class.name.sub(/MechanizeCr::FormContent::/, "").downcase,
+      self.class.name.sub(/Mechanize::FormContent::/, "").downcase,
       object_id, type, name, values.join(','),
     ]
   end

src/mechanize/form/option.cr

@@ -1,4 +1,4 @@
-class MechanizeCr::FormContent::Option
+class Mechanize::FormContent::Option
   getter select_list : FormContent::MultiSelectList
   getter node : Lexbor::Node
   getter text : String

src/mechanize/form/radio_button.cr

@@ -1,4 +1,4 @@
-class MechanizeCr::FormContent::RadioButton < MechanizeCr::FormContent::Field
+class Mechanize::FormContent::RadioButton < Mechanize::FormContent::Field
   property :checked, :form
 
   def initialize(node : Node | Lexbor::Node, form : Form)

src/mechanize/form/reset_button.cr

@@ -1,2 +1,2 @@
-class MechanizeCr::FormContent::ResetButton < MechanizeCr::FormContent::Button
+class Mechanize::FormContent::ResetButton < Mechanize::FormContent::Button
 end

src/mechanize/form/select_list.cr

@@ -1,6 +1,6 @@
 require "./multi_select_list"
 
-class MechanizeCr::FormContent::SelectList < MechanizeCr::FormContent::MultiSelectList
+class Mechanize::FormContent::SelectList < Mechanize::FormContent::MultiSelectList
   def initialize(node)
     super node
     # only one selected option is allowed

src/mechanize/form/submit_button.cr

@@ -1,2 +1,2 @@
-class MechanizeCr::FormContent::SubmitButton < MechanizeCr::FormContent::Button
+class Mechanize::FormContent::SubmitButton < Mechanize::FormContent::Button
 end

src/mechanize/form/text.cr

@@ -1,2 +1,2 @@
-class MechanizeCr::FormContent::Text < MechanizeCr::FormContent::Field
+class Mechanize::FormContent::Text < Mechanize::FormContent::Field
 end

src/mechanize/form/textarea.cr

@@ -1,2 +1,2 @@
-class MechanizeCr::FormContent::Textarea < MechanizeCr::FormContent::Field
+class Mechanize::FormContent::Textarea < Mechanize::FormContent::Field
 end

src/mechanize/history.cr

@@ -1,28 +1,30 @@
 require "./page"
 
-class MechanizeCr::History
+class Mechanize
-  property max_size : Int32
+  class History
-  property array : Array(MechanizeCr::Page)
+    property max_size : Int32
+    property array : Array(Mechanize::Page)
 
-  delegate :size, :empty?, :last, to: array
+    delegate :size, :empty?, :last, to: array
 
-  def initialize(max_size = 100, array = Array(MechanizeCr::Page).new)
+    def initialize(max_size = 100, array = Array(Mechanize::Page).new)
-    @max_size = max_size
+      @max_size = max_size
-    @array = array
+      @array = array
-  end
-
-  def push(page, uri = nil)
-    @array.push(page)
-    while size > @max_size
-      @array.shift
     end
-    self
-  end
 
-  def pop
+    def push(page, uri = nil)
-    if size == 0
+      @array.push(page)
-      # TODO: raise error
+      while size > @max_size
+        @array.shift
+      end
+      self
+    end
+
+    def pop
+      if size == 0
+        # TODO: raise error
+      end
+      page = @array.pop
     end
-    page = @array.pop
   end
 end

src/mechanize/http/agent.cr

@@ -3,16 +3,16 @@ require "http/client"
 require "../cookie"
 require "../history"
 
-module MechanizeCr
+class Mechanize
   module HTTP
     class Agent
       property :request_headers, :context
-      property history : MechanizeCr::History
+      property history : Mechanize::History
       property user_agent : String
       property request_cookies : ::HTTP::Cookies
 
       def initialize(@context : Mechanize | Nil = nil)
-        @history = MechanizeCr::History.new
+        @history = Mechanize::History.new
         @request_headers = ::HTTP::Headers.new
         @context = context
         @request_cookies = ::HTTP::Cookies.new
@@ -96,7 +96,7 @@ module MechanizeCr
       end
 
       # Sets a Referer header.
-      def set_request_referer(referer : MechanizeCr::Page?)
+      def set_request_referer(referer : Mechanize::Page?)
         return unless referer
 
         request_headers["Referer"] = referer.uri.to_s

src/mechanize/page.cr

@@ -6,50 +6,52 @@ require "./page/link"
 # If you send request, it returns the instance of Page.
 # You can get status code, title, and page body, and search html node using css selector.
 
-class MechanizeCr::Page < MechanizeCr::File
+class Mechanize
-  include MechanizeCr::ElementMatcher
+  class Page < Mechanize::File
-  delegate :css, to: parser
+    include Mechanize::ElementMatcher
+    delegate :css, to: parser
 
-  property mech : Mechanize
+    property mech : Mechanize
 
-  def initialize(uri, response, body, code, mech)
+    def initialize(uri, response, body, code, mech)
-    @mech = mech
+      @mech = mech
-    super(uri, response, body, code)
+      super(uri, response, body, code)
-  end
-
-  # parser to parse response body.
-  # TODO: now it's Lexbor::Parser. I want to also support other parsers like JSON.
-  def parser : Lexbor::Parser
-    @parser ||= Lexbor::Parser.new(@body)
-  end
-
-  # return page title.
-  def title : String
-    title_node = css("title")
-    if title_node.empty?
-      ""
-    else
-      title_node.first.inner_text
     end
-  end
 
-  # return all forms(`MechanizeCr::Form`) in the page.
+    # parser to parse response body.
-  def forms : Array(MechanizeCr::Form)
+    # TODO: now it's Lexbor::Parser. I want to also support other parsers like JSON.
-    forms = css("form").map do |html_form|
+    def parser : Lexbor::Parser
-      form = Form.new(html_form, self)
+      @parser ||= Lexbor::Parser.new(@body)
-      form.action ||= @uri.to_s
+    end
-      form
-    end.to_a
-  end
 
-  # return all links(`MechanizeCr::PageContent::Link) in the page.
+    # return page title.
-  def links : Array(MechanizeCr::PageContent::Link)
+    def title : String
-    links = %w{a area}.map do |tag|
+      title_node = css("title")
-      css(tag).map do |node|
+      if title_node.empty?
-        PageContent::Link.new(node, @mech, self)
+        ""
+      else
+        title_node.first.inner_text
       end
-    end.flatten
+    end
-  end
 
-  elements_with "form"
+    # return all forms(`Mechanize::Form`) in the page.
+    def forms : Array(Mechanize::Form)
+      forms = css("form").map do |html_form|
+        form = Mechanize::Form.new(html_form, self)
+        form.action ||= @uri.to_s
+        form
+      end.to_a
+    end
+
+    # return all links(`Mechanize::PageContent::Link) in the page.
+    def links : Array(Mechanize::PageContent::Link)
+      links = %w{a area}.map do |tag|
+        css(tag).map do |node|
+          Mechanize::PageContent::Link.new(node, @mech, self)
+        end
+      end.flatten
+    end
+
+    elements_with "form"
+  end
 end

src/mechanize/page/link.cr

@@ -1,6 +1,6 @@
-class MechanizeCr::PageContent::Link
+class Mechanize::PageContent::Link
   getter node : Lexbor::Node
-  getter page : Page
+  getter page : Mechanize::Page
   getter mech : Mechanize
   getter href : String
   getter text : String

src/mechanize/utils/element_matcher.cr

@@ -1,14 +1,15 @@
-module MechanizeCr::ElementMatcher
+class Mechanize
-  macro elements_with(singular, plural = "")
+  module ElementMatcher
+    macro elements_with(singular, plural = "")
     {% plural = "#{singular.id}s" if plural.empty? %}
     # search {{ singular.id }} which matches condition.
-    # 
+    #
     # Examples
     # ```
     # # if you specify String like "foo", it searches form which name is "foo".
     # # like {<form name="foo"></form>}
-    # page.form_with("foo") 
+    # page.form_with("foo")
-    # 
+    #
     # # you can specify tag's attribute and its' value by NamedTuple or Hash(String, String).
     # ex) <form class="foo"></form>
     # page.form_with("class" => "foo")
@@ -46,8 +47,9 @@ module MechanizeCr::ElementMatcher
     def {{singular.id}}_with(criteria)
       f = {{plural.id}}_with(criteria)
       # TODO: Write correct error message.
-      raise ElementNotFoundError.new(:{{singular.id}}, "") if f.empty?
+      raise Mechanize::ElementNotFoundError.new(:{{singular.id}}, "") if f.empty?
       f.first
     end
   end
+  end
 end