a1 1.0.1

A package for converting to and from A1 spreadsheet notation
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

//! # Address
//!
//! Represents a particular cell.  You treat an `Address` as any other type using the relevant
//! `AsRef` or `Into` implementations.
//!
use crate::{Column, Index, Row};

mod as_ref;
mod display;
mod from;
mod from_str;
mod into;

#[cfg_attr(
    feature = "rkyv",
    derive(rkyv::Archive, rkyv::Deserialize, rkyv::Serialize)
)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
#[derive(Copy, Clone, Debug, PartialEq)]
pub struct Address {
    pub column: Column,
    pub row: Row,
}

impl Address {
    pub fn new(column_index: Index, row_index: Index) -> Self {
        Self {
            column: column_index.into(),
            row: row_index.into(),
        }
    }

    /// Given that `a` and `b` form a finite range, is `self` within it? i.e. is_between `a` and
    /// `b`.
    pub fn is_between(&self, a: &Self, b: &Self) -> bool {
        let a_dist = a.origin_distance();
        let b_dist = b.origin_distance();

        let top_left = if a_dist < b_dist { a } else { b };
        let bottom_right = if a_dist < b_dist { b } else { a };

        self.column >= top_left.column
            && self.row >= top_left.row
            && self.column <= bottom_right.column
            && self.row <= bottom_right.row
    }

    pub fn shift_down(&self, rows: Index) -> Self {
        Self {
            row: self.row.shift_down(rows),
            ..*self
        }
    }

    pub fn shift_left(&self, columns: Index) -> Self {
        Self {
            column: self.column.shift_left(columns),
            ..*self
        }
    }

    pub fn shift_right(&self, columns: Index) -> Self {
        Self {
            column: self.column.shift_right(columns),
            ..*self
        }
    }

    pub fn shift_up(&self, rows: Index) -> Self {
        Self {
            row: self.row.shift_up(rows),
            ..*self
        }
    }

    /// Set the `x` component with the following (hopefully sensical rules):
    pub fn with_x(&self, x: Index) -> Self {
        Self {
            column: x.into(),
            ..*self
        }
    }

    /// Set the `y` component with the following
    pub fn with_y(&self, y: Index) -> Self {
        Self {
            row: y.into(),
            ..*self
        }
    }

    pub(crate) fn origin_distance(&self) -> usize {
        self.column.x + self.row.y
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn is_between_true() {
        let a: Address = (5, 5).into();

        assert!(a.is_between(&(0, 0).into(), &(10, 10).into()));
        assert!(a.is_between(&(4, 5).into(), &(6, 5).into()));
    }

    #[test]
    fn is_between_false() {
        let a: Address = (5, 5).into();

        assert!(!a.is_between(&(8, 8).into(), &(10, 10).into()));
    }

    #[test]
    fn shift_down() {
        assert_eq!(Address::new(2, 2).shift_down(1), (2, 3).into());
        assert_eq!(Address::new(2, 2).shift_down(10), (2, 12).into());
    }

    #[test]
    fn shift_left() {
        assert_eq!(Address::new(2, 2).shift_left(1), (1, 2).into());
        assert_eq!(Address::new(2, 2).shift_left(10), (0, 2).into());
    }

    #[test]
    fn shift_right() {
        assert_eq!(Address::new(2, 2).shift_right(1), (3, 2).into());
        assert_eq!(Address::new(2, 2).shift_right(10), (12, 2).into());
    }

    #[test]
    fn shift_up() {
        assert_eq!(Address::new(2, 2).shift_up(1), (2, 1).into());
        assert_eq!(Address::new(2, 2).shift_up(10), (2, 0).into());
    }
}